secure/lib/libcrypto/man/ERR_get_error.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "ERR_get_error 3"
 132 .TH ERR_get_error 3 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 ERR_get_error, ERR_peek_error, ERR_peek_last_error,
 139 ERR_get_error_line, ERR_peek_error_line, ERR_peek_last_error_line,
 140 ERR_get_error_line_data, ERR_peek_error_line_data,
 141 ERR_peek_last_error_line_data \- obtain error code and data
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 1
 145 \& #include <openssl/err.h>
 146 \&
 147 \& unsigned long ERR_get_error(void);
 148 \& unsigned long ERR_peek_error(void);
 149 \& unsigned long ERR_peek_last_error(void);
 150 \&
 151 \& unsigned long ERR_get_error_line(const char **file, int *line);
 152 \& unsigned long ERR_peek_error_line(const char **file, int *line);
 153 \& unsigned long ERR_peek_last_error_line(const char **file, int *line);
 154 \&
 155 \& unsigned long ERR_get_error_line_data(const char **file, int *line,
 156 \&         const char **data, int *flags);
 157 \& unsigned long ERR_peek_error_line_data(const char **file, int *line,
 158 \&         const char **data, int *flags);
 159 \& unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 160 \&         const char **data, int *flags);
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 \&\fIERR_get_error()\fR returns the earliest error code from the thread's error
 165 queue and removes the entry. This function can be called repeatedly
 166 until there are no more error codes to return.
 167 .PP
 168 \&\fIERR_peek_error()\fR returns the earliest error code from the thread's
 169 error queue without modifying it.
 170 .PP
 171 \&\fIERR_peek_last_error()\fR returns the latest error code from the thread's
 172 error queue without modifying it.
 173 .PP
 174 See \s-1\fIERR_GET_LIB\s0\fR\|(3) for obtaining information about
 175 location and reason of the error, and
 176 \&\fIERR_error_string\fR\|(3) for human-readable error
 177 messages.
 178 .PP
 179 \&\fIERR_get_error_line()\fR, \fIERR_peek_error_line()\fR and
 180 \&\fIERR_peek_last_error_line()\fR are the same as the above, but they
 181 additionally store the file name and line number where
 182 the error occurred in *\fBfile\fR and *\fBline\fR, unless these are \fB\s-1NULL\s0\fR.
 183 .PP
 184 \&\fIERR_get_error_line_data()\fR, \fIERR_peek_error_line_data()\fR and
 185 \&\fIERR_peek_last_error_line_data()\fR store additional data and flags
 186 associated with the error code in *\fBdata\fR
 187 and *\fBflags\fR, unless these are \fB\s-1NULL\s0\fR. *\fBdata\fR contains a string
 188 if *\fBflags\fR&\fB\s-1ERR_TXT_STRING\s0\fR is true.
 189 .PP
 190 An application \fB\s-1MUST NOT\s0\fR free the *\fBdata\fR pointer (or any other pointers
 191 returned by these functions) with \fIOPENSSL_free()\fR as freeing is handled
 192 automatically by the error library.
 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.