secure/lib/libcrypto/man/ERR_error_string.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   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.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  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 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), 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 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  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_error_string 3"
 132 .TH ERR_error_string 3 "2007-03-28" "0.9.8e" "OpenSSL"
 133 .SH "NAME"
 134 ERR_error_string, ERR_error_string_n, ERR_lib_error_string,
 135 ERR_func_error_string, ERR_reason_error_string \- obtain human\-readable
 136 error message
 137 .SH "SYNOPSIS"
 138 .IX Header "SYNOPSIS"
 139 .Vb 1
 140 \& #include <openssl/err.h>
 141 .Ve
 142 .PP
 143 .Vb 2
 144 \& char *ERR_error_string(unsigned long e, char *buf);
 145 \& void ERR_error_string_n(unsigned long e, char *buf, size_t len);
 146 .Ve
 147 .PP
 148 .Vb 3
 149 \& const char *ERR_lib_error_string(unsigned long e);
 150 \& const char *ERR_func_error_string(unsigned long e);
 151 \& const char *ERR_reason_error_string(unsigned long e);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 \&\fIERR_error_string()\fR generates a human-readable string representing the
 156 error code \fIe\fR, and places it at \fIbuf\fR. \fIbuf\fR must be at least 120
 157 bytes long. If \fIbuf\fR is \fB\s-1NULL\s0\fR, the error string is placed in a
 158 static buffer.
 159 \&\fIERR_error_string_n()\fR is a variant of \fIERR_error_string()\fR that writes
 160 at most \fIlen\fR characters (including the terminating 0)
 161 and truncates the string if necessary.
 162 For \fIERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR.
 163 .PP
 164 The string will have the following format:
 165 .PP
 166 .Vb 1
 167 \& error:[error code]:[library name]:[function name]:[reason string]
 168 .Ve
 169 .PP
 170 \&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR,
 171 \&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text.
 172 .PP
 173 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
 174 \&\fIERR_reason_error_string()\fR return the library name, function
 175 name and reason string respectively.
 176 .PP
 177 The OpenSSL error strings should be loaded by calling
 178 \&\fIERR_load_crypto_strings\fR\|(3) or, for \s-1SSL\s0
 179 applications, \fISSL_load_error_strings\fR\|(3)
 180 first.
 181 If there is no text string registered for the given error code,
 182 the error string will contain the numeric code.
 183 .PP
 184 \&\fIERR_print_errors\fR\|(3) can be used to print
 185 all error codes currently in the queue.
 186 .SH "RETURN VALUES"
 187 .IX Header "RETURN VALUES"
 188 \&\fIERR_error_string()\fR returns a pointer to a static buffer containing the
 189 string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise.
 190 .PP
 191 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
 192 \&\fIERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if
 193 none is registered for the error code.
 194 .SH "SEE ALSO"
 195 .IX Header "SEE ALSO"
 196 \&\fIerr\fR\|(3), \fIERR_get_error\fR\|(3),
 197 \&\fIERR_load_crypto_strings\fR\|(3),
 198 \&\fISSL_load_error_strings\fR\|(3)
 199 \&\fIERR_print_errors\fR\|(3)
 200 .SH "HISTORY"
 201 .IX Header "HISTORY"
 202 \&\fIERR_error_string()\fR is available in all versions of SSLeay and OpenSSL.
 203 \&\fIERR_error_string_n()\fR was added in OpenSSL 0.9.6.