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