Merge branch 'vendor/WPA_SUPPLICANT'
[dragonfly.git] / secure / lib / libcrypto / man / ERR_get_error.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
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
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
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'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
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
107 .    \" corrections for vroff
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'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
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
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "ERR_get_error 3"
127 .TH ERR_get_error 3 "2014-04-07" "1.0.1g" "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
132 .SH "NAME"
133 ERR_get_error, ERR_peek_error, ERR_peek_last_error,
134 ERR_get_error_line, ERR_peek_error_line, ERR_peek_last_error_line,
135 ERR_get_error_line_data, ERR_peek_error_line_data,
136 ERR_peek_last_error_line_data \- obtain error code and data
137 .SH "SYNOPSIS"
138 .IX Header "SYNOPSIS"
139 .Vb 1
140 \& #include <openssl/err.h>
141 \&
142 \& unsigned long ERR_get_error(void);
143 \& unsigned long ERR_peek_error(void);
144 \& unsigned long ERR_peek_last_error(void);
145 \&
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);
149 \&
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"
158 .IX Header "DESCRIPTION"
159 \&\fIERR_get_error()\fR returns the earliest error code from the thread's error
160 queue and removes the entry. This function can be called repeatedly
161 until there are no more error codes to return.
162 .PP
163 \&\fIERR_peek_error()\fR returns the earliest error code from the thread's
164 error queue without modifying it.
165 .PP
166 \&\fIERR_peek_last_error()\fR returns the latest error code from the thread's
167 error queue without modifying it.
168 .PP
169 See \s-1\fIERR_GET_LIB\s0\fR\|(3) for obtaining information about
170 location and reason of the error, and
171 \&\fIERR_error_string\fR\|(3) for human-readable error
172 messages.
173 .PP
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
176 additionally store the file name and line number where
177 the error occurred in *\fBfile\fR and *\fBline\fR, unless these are \fB\s-1NULL\s0\fR.
178 .PP
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
181 associated with the error code in *\fBdata\fR
182 and *\fBflags\fR, unless these are \fB\s-1NULL\s0\fR. *\fBdata\fR contains a string
183 if *\fBflags\fR&\fB\s-1ERR_TXT_STRING\s0\fR is true.
184 .PP
185 An application \fB\s-1MUST\s0 \s-1NOT\s0\fR free the *\fBdata\fR pointer (or any other pointers
186 returned by these functions) with \fIOPENSSL_free()\fR as freeing is handled
187 automatically by the error library.
188 .SH "RETURN VALUES"
189 .IX Header "RETURN VALUES"
190 The error code, or 0 if there is no error in the queue.
191 .SH "SEE ALSO"
192 .IX Header "SEE ALSO"
193 \&\fIerr\fR\|(3), \fIERR_error_string\fR\|(3),
194 \&\s-1\fIERR_GET_LIB\s0\fR\|(3)
195 .SH "HISTORY"
196 .IX Header "HISTORY"
197 \&\fIERR_get_error()\fR, \fIERR_peek_error()\fR, \fIERR_get_error_line()\fR and
198 \&\fIERR_peek_error_line()\fR are available in all versions of SSLeay and
199 OpenSSL. \fIERR_get_error_line_data()\fR and \fIERR_peek_error_line_data()\fR
200 were added in SSLeay 0.9.0.
201 \&\fIERR_peek_last_error()\fR, \fIERR_peek_last_error_line()\fR and
202 \&\fIERR_peek_last_error_line_data()\fR were added in OpenSSL 0.9.7.