260 lines
9.7 KiB
Groff
260 lines
9.7 KiB
Groff
|
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
||
|
.\"
|
||
|
.\" Standard preamble:
|
||
|
.\" ========================================================================
|
||
|
.de Sp \" Vertical space (when we can't use .PP)
|
||
|
.if t .sp .5v
|
||
|
.if n .sp
|
||
|
..
|
||
|
.de Vb \" Begin verbatim text
|
||
|
.ft CW
|
||
|
.nf
|
||
|
.ne \\$1
|
||
|
..
|
||
|
.de Ve \" End verbatim text
|
||
|
.ft R
|
||
|
.fi
|
||
|
..
|
||
|
.\" Set up some character translations and predefined strings. \*(-- will
|
||
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
||
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
||
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
||
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
||
|
.\" nothing in troff, for use with C<>.
|
||
|
.tr \(*W-
|
||
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||
|
.ie n \{\
|
||
|
. ds -- \(*W-
|
||
|
. ds PI pi
|
||
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
||
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||
|
. ds L" ""
|
||
|
. ds R" ""
|
||
|
. ds C` ""
|
||
|
. ds C' ""
|
||
|
'br\}
|
||
|
.el\{\
|
||
|
. ds -- \|\(em\|
|
||
|
. ds PI \(*p
|
||
|
. ds L" ``
|
||
|
. ds R" ''
|
||
|
'br\}
|
||
|
.\"
|
||
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
||
|
.ie \n(.g .ds Aq \(aq
|
||
|
.el .ds Aq '
|
||
|
.\"
|
||
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
||
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||
|
.\" output yourself in some meaningful fashion.
|
||
|
.ie \nF \{\
|
||
|
. de IX
|
||
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
..
|
||
|
. nr % 0
|
||
|
. rr F
|
||
|
.\}
|
||
|
.el \{\
|
||
|
. de IX
|
||
|
..
|
||
|
.\}
|
||
|
.\"
|
||
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||
|
. \" fudge factors for nroff and troff
|
||
|
.if n \{\
|
||
|
. ds #H 0
|
||
|
. ds #V .8m
|
||
|
. ds #F .3m
|
||
|
. ds #[ \f1
|
||
|
. ds #] \fP
|
||
|
.\}
|
||
|
.if t \{\
|
||
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||
|
. ds #V .6m
|
||
|
. ds #F 0
|
||
|
. ds #[ \&
|
||
|
. ds #] \&
|
||
|
.\}
|
||
|
. \" simple accents for nroff and troff
|
||
|
.if n \{\
|
||
|
. ds ' \&
|
||
|
. ds ` \&
|
||
|
. ds ^ \&
|
||
|
. ds , \&
|
||
|
. ds ~ ~
|
||
|
. ds /
|
||
|
.\}
|
||
|
.if t \{\
|
||
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
||
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
||
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
||
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
||
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
||
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
||
|
.\}
|
||
|
. \" troff and (daisy-wheel) nroff accents
|
||
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
||
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||
|
. \" corrections for vroff
|
||
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||
|
. \" for low resolution devices (crt and lpr)
|
||
|
.if \n(.H>23 .if \n(.V>19 \
|
||
|
\{\
|
||
|
. ds : e
|
||
|
. ds 8 ss
|
||
|
. ds o a
|
||
|
. ds d- d\h'-1'\(ga
|
||
|
. ds D- D\h'-1'\(hy
|
||
|
. ds th \o'bp'
|
||
|
. ds Th \o'LP'
|
||
|
. ds ae ae
|
||
|
. ds Ae AE
|
||
|
.\}
|
||
|
.rm #[ #] #H #V #F C
|
||
|
.\" ========================================================================
|
||
|
.\"
|
||
|
.IX Title "ERR_GET_ERROR 3"
|
||
|
.TH ERR_GET_ERROR 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
||
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||
|
.\" way too many mistakes in technical documents.
|
||
|
.if n .ad l
|
||
|
.nh
|
||
|
.SH "NAME"
|
||
|
ERR_get_error, ERR_peek_error, ERR_peek_last_error,
|
||
|
ERR_get_error_line, ERR_peek_error_line, ERR_peek_last_error_line,
|
||
|
ERR_get_error_func, ERR_peek_error_func, ERR_peek_last_error_func,
|
||
|
ERR_get_error_data, ERR_peek_error_data, ERR_peek_last_error_data,
|
||
|
ERR_get_error_all, ERR_peek_error_all, ERR_peek_last_error_all,
|
||
|
ERR_get_error_line_data, ERR_peek_error_line_data, ERR_peek_last_error_line_data
|
||
|
\&\- obtain error code and data
|
||
|
.SH "SYNOPSIS"
|
||
|
.IX Header "SYNOPSIS"
|
||
|
.Vb 1
|
||
|
\& #include <openssl/err.h>
|
||
|
\&
|
||
|
\& unsigned long ERR_get_error(void);
|
||
|
\& unsigned long ERR_peek_error(void);
|
||
|
\& unsigned long ERR_peek_last_error(void);
|
||
|
\&
|
||
|
\& unsigned long ERR_get_error_line(const char **file, int *line);
|
||
|
\& unsigned long ERR_peek_error_line(const char **file, int *line);
|
||
|
\& unsigned long ERR_peek_last_error_line(const char **file, int *line);
|
||
|
\&
|
||
|
\& unsigned long ERR_get_error_func(const char **func);
|
||
|
\& unsigned long ERR_peek_error_func(const char **func);
|
||
|
\& unsigned long ERR_peek_last_error_func(const char **func);
|
||
|
\&
|
||
|
\& unsigned long ERR_get_error_data(const char **data, int *flags);
|
||
|
\& unsigned long ERR_peek_error_data(const char **data, int *flags);
|
||
|
\& unsigned long ERR_peek_last_error_data(const char **data, int *flags);
|
||
|
\&
|
||
|
\& unsigned long ERR_get_error_all(const char **file, int *line,
|
||
|
\& const char *func,
|
||
|
\& const char **data, int *flags);
|
||
|
\& unsigned long ERR_peek_error_all(const char **file, int *line,
|
||
|
\& const char *func,
|
||
|
\& const char **data, int *flags);
|
||
|
\& unsigned long ERR_peek_last_error_all(const char **file, int *line,
|
||
|
\& const char *func,
|
||
|
\& const char **data, int *flags);
|
||
|
.Ve
|
||
|
.PP
|
||
|
Deprecated since OpenSSL 3.0:
|
||
|
.PP
|
||
|
.Vb 6
|
||
|
\& unsigned long ERR_get_error_line_data(const char **file, int *line,
|
||
|
\& const char **data, int *flags);
|
||
|
\& unsigned long ERR_peek_error_line_data(const char **file, int *line,
|
||
|
\& const char **data, int *flags);
|
||
|
\& unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
|
||
|
\& const char **data, int *flags);
|
||
|
.Ve
|
||
|
.SH "DESCRIPTION"
|
||
|
.IX Header "DESCRIPTION"
|
||
|
\&\fIERR_get_error()\fR returns the earliest error code from the thread's error
|
||
|
queue and removes the entry. This function can be called repeatedly
|
||
|
until there are no more error codes to return.
|
||
|
.PP
|
||
|
\&\fIERR_peek_error()\fR returns the earliest error code from the thread's
|
||
|
error queue without modifying it.
|
||
|
.PP
|
||
|
\&\fIERR_peek_last_error()\fR returns the latest error code from the thread's
|
||
|
error queue without modifying it.
|
||
|
.PP
|
||
|
See \s-1\fIERR_GET_LIB\s0\fR\|(3) for obtaining further specific information
|
||
|
such as the reason of the error,
|
||
|
and \fIERR_error_string\fR\|(3) for human-readable error messages.
|
||
|
.PP
|
||
|
\&\fIERR_get_error_line()\fR, \fIERR_peek_error_line()\fR and
|
||
|
\&\fIERR_peek_last_error_line()\fR are the same as \fIERR_get_error()\fR,
|
||
|
\&\fIERR_peek_error()\fR and \fIERR_peek_last_error()\fR, but on success they
|
||
|
additionally store the filename and line number where
|
||
|
the error occurred in *\fBfile\fR and *\fBline\fR, as far as they are not \fB\s-1NULL\s0\fR.
|
||
|
An unset filename is indicated as \fB""\fR, i.e., an empty string.
|
||
|
An unset line number is indicated as \fB0\fR.
|
||
|
.PP
|
||
|
A pointer returned this way by these functions and the ones below
|
||
|
is valid until the respective entry is removed from the error queue.
|
||
|
.PP
|
||
|
\&\fIERR_get_error_func()\fR, \fIERR_peek_error_func()\fR and
|
||
|
\&\fIERR_peek_last_error_func()\fR are the same as \fIERR_get_error()\fR,
|
||
|
\&\fIERR_peek_error()\fR and \fIERR_peek_last_error()\fR, but on success they
|
||
|
additionally store the name of the function where the error occurred
|
||
|
in *\fBfunc\fR, unless it is \fB\s-1NULL\s0\fR.
|
||
|
An unset function name is indicated as \fB""\fR.
|
||
|
.PP
|
||
|
\&\fIERR_get_error_data()\fR, \fIERR_peek_error_data()\fR and
|
||
|
\&\fIERR_peek_last_error_data()\fR are the same as \fIERR_get_error()\fR,
|
||
|
\&\fIERR_peek_error()\fR and \fIERR_peek_last_error()\fR, but on success they
|
||
|
additionally store additional data and flags associated with the error
|
||
|
code in *\fBdata\fR and *\fBflags\fR, as far as they are not \fB\s-1NULL\s0\fR.
|
||
|
Unset data is indicated as \fB""\fR.
|
||
|
In this case the value given for the flag is irrelevant (and equals \fB0\fR).
|
||
|
*\fBdata\fR contains a string if *\fBflags\fR&\fB\s-1ERR_TXT_STRING\s0\fR is true.
|
||
|
.PP
|
||
|
\&\fIERR_get_error_all()\fR, \fIERR_peek_error_all()\fR and
|
||
|
\&\fIERR_peek_last_error_all()\fR are combinations of all of the above.
|
||
|
.PP
|
||
|
\&\fIERR_get_error_line_data()\fR, \fIERR_peek_error_line_data()\fR and
|
||
|
\&\fIERR_peek_last_error_line_data()\fR are older variants of \fIERR_get_error_all()\fR,
|
||
|
\&\fIERR_peek_error_all()\fR and \fIERR_peek_last_error_all()\fR, and should no longer
|
||
|
be used.
|
||
|
.PP
|
||
|
An application \fB\s-1MUST\s0 \s-1NOT\s0\fR free the *\fBdata\fR pointer (or any other pointers
|
||
|
returned by these functions) with \fIOPENSSL_free()\fR as freeing is handled
|
||
|
automatically by the error library.
|
||
|
.SH "RETURN VALUES"
|
||
|
.IX Header "RETURN VALUES"
|
||
|
The error code, or 0 if there is no error in the queue.
|
||
|
.SH "SEE ALSO"
|
||
|
.IX Header "SEE ALSO"
|
||
|
\&\fIERR_error_string\fR\|(3),
|
||
|
\&\s-1\fIERR_GET_LIB\s0\fR\|(3)
|
||
|
.SH "HISTORY"
|
||
|
.IX Header "HISTORY"
|
||
|
\&\fIERR_get_error_func()\fR, \fIERR_peek_error_func()\fR, \fIERR_peek_last_error_func()\fR,
|
||
|
\&\fIERR_get_error_data()\fR, \fIERR_peek_error_data()\fR, \fIERR_peek_last_error_data()\fR,
|
||
|
\&\fIERR_get_error_all()\fR, \fIERR_peek_error_all()\fR and \fIERR_peek_last_error_all()\fR
|
||
|
were added in OpenSSL 3.0.
|
||
|
.PP
|
||
|
\&\fIERR_get_error_line_data()\fR, \fIERR_peek_error_line_data()\fR and
|
||
|
\&\fIERR_peek_last_error_line_data()\fR became deprecated in OpenSSL 3.0.
|
||
|
.SH "COPYRIGHT"
|
||
|
.IX Header "COPYRIGHT"
|
||
|
Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
.PP
|
||
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
||
|
this file except in compliance with the License. You can obtain a copy
|
||
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
||
|
<https://www.openssl.org/source/license.html>.
|