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