Merge from vendor branch OPENSSL:
[dragonfly.git] / secure / lib / libcrypto / man / ERR_get_error.3
CommitLineData
2eaa1526 1.\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
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
2eaa1526
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
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.\"
8b0cefbb
JR
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 107. \" corrections for vroff
984263bc
MD
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "ERR_get_error 3"
2eaa1526
PA
127.TH ERR_get_error 3 "2007-10-24" "0.9.8g" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
984263bc
MD
132.SH "NAME"
133ERR_get_error, ERR_peek_error, ERR_peek_last_error,
134ERR_get_error_line, ERR_peek_error_line, ERR_peek_last_error_line,
135ERR_get_error_line_data, ERR_peek_error_line_data,
136ERR_peek_last_error_line_data \- obtain error code and data
137.SH "SYNOPSIS"
8b0cefbb 138.IX Header "SYNOPSIS"
984263bc
MD
139.Vb 1
140\& #include <openssl/err.h>
2eaa1526 141\&
984263bc
MD
142\& unsigned long ERR_get_error(void);
143\& unsigned long ERR_peek_error(void);
144\& unsigned long ERR_peek_last_error(void);
2eaa1526 145\&
984263bc
MD
146\& unsigned long ERR_get_error_line(const char **file, int *line);
147\& unsigned long ERR_peek_error_line(const char **file, int *line);
148\& unsigned long ERR_peek_last_error_line(const char **file, int *line);
2eaa1526 149\&
984263bc
MD
150\& unsigned long ERR_get_error_line_data(const char **file, int *line,
151\& const char **data, int *flags);
152\& unsigned long ERR_peek_error_line_data(const char **file, int *line,
153\& const char **data, int *flags);
154\& unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
155\& const char **data, int *flags);
156.Ve
157.SH "DESCRIPTION"
8b0cefbb
JR
158.IX Header "DESCRIPTION"
159\&\fIERR_get_error()\fR returns the earliest error code from the thread's error
984263bc
MD
160queue and removes the entry. This function can be called repeatedly
161until there are no more error codes to return.
162.PP
8b0cefbb 163\&\fIERR_peek_error()\fR returns the earliest error code from the thread's
984263bc
MD
164error queue without modifying it.
165.PP
8b0cefbb 166\&\fIERR_peek_last_error()\fR returns the latest error code from the thread's
984263bc
MD
167error queue without modifying it.
168.PP
8b0cefbb 169See \s-1\fIERR_GET_LIB\s0\fR\|(3) for obtaining information about
984263bc 170location and reason of the error, and
8b0cefbb 171\&\fIERR_error_string\fR\|(3) for human-readable error
984263bc
MD
172messages.
173.PP
8b0cefbb
JR
174\&\fIERR_get_error_line()\fR, \fIERR_peek_error_line()\fR and
175\&\fIERR_peek_last_error_line()\fR are the same as the above, but they
984263bc 176additionally store the file name and line number where
8b0cefbb 177the error occurred in *\fBfile\fR and *\fBline\fR, unless these are \fB\s-1NULL\s0\fR.
984263bc 178.PP
8b0cefbb
JR
179\&\fIERR_get_error_line_data()\fR, \fIERR_peek_error_line_data()\fR and
180\&\fIERR_get_last_error_line_data()\fR store additional data and flags
984263bc 181associated with the error code in *\fBdata\fR
8b0cefbb
JR
182and *\fBflags\fR, unless these are \fB\s-1NULL\s0\fR. *\fBdata\fR contains a string
183if *\fBflags\fR&\fB\s-1ERR_TXT_STRING\s0\fR. If it has been allocated by \fIOPENSSL_malloc()\fR,
184*\fBflags\fR&\fB\s-1ERR_TXT_MALLOCED\s0\fR is true.
984263bc 185.SH "RETURN VALUES"
8b0cefbb 186.IX Header "RETURN VALUES"
984263bc
MD
187The error code, or 0 if there is no error in the queue.
188.SH "SEE ALSO"
8b0cefbb
JR
189.IX Header "SEE ALSO"
190\&\fIerr\fR\|(3), \fIERR_error_string\fR\|(3),
191\&\s-1\fIERR_GET_LIB\s0\fR\|(3)
984263bc 192.SH "HISTORY"
8b0cefbb
JR
193.IX Header "HISTORY"
194\&\fIERR_get_error()\fR, \fIERR_peek_error()\fR, \fIERR_get_error_line()\fR and
195\&\fIERR_peek_error_line()\fR are available in all versions of SSLeay and
984263bc
MD
196OpenSSL. \fIERR_get_error_line_data()\fR and \fIERR_peek_error_line_data()\fR
197were added in SSLeay 0.9.0.
8b0cefbb
JR
198\&\fIERR_peek_last_error()\fR, \fIERR_peek_last_error_line()\fR and
199\&\fIERR_peek_last_error_line_data()\fR were added in OpenSSL 0.9.7.