1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "ERR_error_string 3"
135 .TH ERR_error_string 3 "2009-04-11" "0.9.8k" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 ERR_error_string, ERR_error_string_n, ERR_lib_error_string,
142 ERR_func_error_string, ERR_reason_error_string \- obtain human\-readable
145 .IX Header "SYNOPSIS"
147 \& #include <openssl/err.h>
149 \& char *ERR_error_string(unsigned long e, char *buf);
150 \& void ERR_error_string_n(unsigned long e, char *buf, size_t len);
152 \& const char *ERR_lib_error_string(unsigned long e);
153 \& const char *ERR_func_error_string(unsigned long e);
154 \& const char *ERR_reason_error_string(unsigned long e);
157 .IX Header "DESCRIPTION"
158 \&\fIERR_error_string()\fR generates a human-readable string representing the
159 error code \fIe\fR, and places it at \fIbuf\fR. \fIbuf\fR must be at least 120
160 bytes long. If \fIbuf\fR is \fB\s-1NULL\s0\fR, the error string is placed in a
162 \&\fIERR_error_string_n()\fR is a variant of \fIERR_error_string()\fR that writes
163 at most \fIlen\fR characters (including the terminating 0)
164 and truncates the string if necessary.
165 For \fIERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR.
167 The string will have the following format:
170 \& error:[error code]:[library name]:[function name]:[reason string]
173 \&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR,
174 \&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text.
176 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
177 \&\fIERR_reason_error_string()\fR return the library name, function
178 name and reason string respectively.
180 The OpenSSL error strings should be loaded by calling
181 \&\fIERR_load_crypto_strings\fR\|(3) or, for \s-1SSL\s0
182 applications, \fISSL_load_error_strings\fR\|(3)
184 If there is no text string registered for the given error code,
185 the error string will contain the numeric code.
187 \&\fIERR_print_errors\fR\|(3) can be used to print
188 all error codes currently in the queue.
190 .IX Header "RETURN VALUES"
191 \&\fIERR_error_string()\fR returns a pointer to a static buffer containing the
192 string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise.
194 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
195 \&\fIERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if
196 none is registered for the error code.
198 .IX Header "SEE ALSO"
199 \&\fIerr\fR\|(3), \fIERR_get_error\fR\|(3),
200 \&\fIERR_load_crypto_strings\fR\|(3),
201 \&\fISSL_load_error_strings\fR\|(3)
202 \&\fIERR_print_errors\fR\|(3)
205 \&\fIERR_error_string()\fR is available in all versions of SSLeay and OpenSSL.
206 \&\fIERR_error_string_n()\fR was added in OpenSSL 0.9.6.