crypto/external/bsd/openssl/lib/libcrypto/man/ERR_get_error.3

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