Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / lib / libcrypto / man / ERR_get_error.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "ERR_get_error 3"
18ed9402 132.TH ERR_get_error 3 "2008-09-27" "0.9.8i" "OpenSSL"
984263bc
MD
133.SH "NAME"
134ERR_get_error, ERR_peek_error, ERR_peek_last_error,
135ERR_get_error_line, ERR_peek_error_line, ERR_peek_last_error_line,
136ERR_get_error_line_data, ERR_peek_error_line_data,
137ERR_peek_last_error_line_data \- obtain error code and data
138.SH "SYNOPSIS"
8b0cefbb 139.IX Header "SYNOPSIS"
984263bc
MD
140.Vb 1
141\& #include <openssl/err.h>
aac4ff6f
PA
142.Ve
143.PP
144.Vb 3
984263bc
MD
145\& unsigned long ERR_get_error(void);
146\& unsigned long ERR_peek_error(void);
147\& unsigned long ERR_peek_last_error(void);
aac4ff6f
PA
148.Ve
149.PP
150.Vb 3
984263bc
MD
151\& unsigned long ERR_get_error_line(const char **file, int *line);
152\& unsigned long ERR_peek_error_line(const char **file, int *line);
153\& unsigned long ERR_peek_last_error_line(const char **file, int *line);
aac4ff6f
PA
154.Ve
155.PP
156.Vb 6
984263bc
MD
157\& unsigned long ERR_get_error_line_data(const char **file, int *line,
158\& const char **data, int *flags);
159\& unsigned long ERR_peek_error_line_data(const char **file, int *line,
160\& const char **data, int *flags);
161\& unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
162\& const char **data, int *flags);
163.Ve
164.SH "DESCRIPTION"
8b0cefbb
JR
165.IX Header "DESCRIPTION"
166\&\fIERR_get_error()\fR returns the earliest error code from the thread's error
984263bc
MD
167queue and removes the entry. This function can be called repeatedly
168until there are no more error codes to return.
169.PP
8b0cefbb 170\&\fIERR_peek_error()\fR returns the earliest error code from the thread's
984263bc
MD
171error queue without modifying it.
172.PP
8b0cefbb 173\&\fIERR_peek_last_error()\fR returns the latest error code from the thread's
984263bc
MD
174error queue without modifying it.
175.PP
8b0cefbb 176See \s-1\fIERR_GET_LIB\s0\fR\|(3) for obtaining information about
984263bc 177location and reason of the error, and
8b0cefbb 178\&\fIERR_error_string\fR\|(3) for human-readable error
984263bc
MD
179messages.
180.PP
8b0cefbb
JR
181\&\fIERR_get_error_line()\fR, \fIERR_peek_error_line()\fR and
182\&\fIERR_peek_last_error_line()\fR are the same as the above, but they
984263bc 183additionally store the file name and line number where
8b0cefbb 184the error occurred in *\fBfile\fR and *\fBline\fR, unless these are \fB\s-1NULL\s0\fR.
984263bc 185.PP
8b0cefbb
JR
186\&\fIERR_get_error_line_data()\fR, \fIERR_peek_error_line_data()\fR and
187\&\fIERR_get_last_error_line_data()\fR store additional data and flags
984263bc 188associated with the error code in *\fBdata\fR
8b0cefbb
JR
189and *\fBflags\fR, unless these are \fB\s-1NULL\s0\fR. *\fBdata\fR contains a string
190if *\fBflags\fR&\fB\s-1ERR_TXT_STRING\s0\fR. If it has been allocated by \fIOPENSSL_malloc()\fR,
191*\fBflags\fR&\fB\s-1ERR_TXT_MALLOCED\s0\fR is true.
984263bc 192.SH "RETURN VALUES"
8b0cefbb 193.IX Header "RETURN VALUES"
984263bc
MD
194The error code, or 0 if there is no error in the queue.
195.SH "SEE ALSO"
8b0cefbb
JR
196.IX Header "SEE ALSO"
197\&\fIerr\fR\|(3), \fIERR_error_string\fR\|(3),
198\&\s-1\fIERR_GET_LIB\s0\fR\|(3)
984263bc 199.SH "HISTORY"
8b0cefbb
JR
200.IX Header "HISTORY"
201\&\fIERR_get_error()\fR, \fIERR_peek_error()\fR, \fIERR_get_error_line()\fR and
202\&\fIERR_peek_error_line()\fR are available in all versions of SSLeay and
984263bc
MD
203OpenSSL. \fIERR_get_error_line_data()\fR and \fIERR_peek_error_line_data()\fR
204were added in SSLeay 0.9.0.
8b0cefbb
JR
205\&\fIERR_peek_last_error()\fR, \fIERR_peek_last_error_line()\fR and
206\&\fIERR_peek_last_error_line_data()\fR were added in OpenSSL 0.9.7.