1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Tue Jul 30 09:21:36 2002
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "ERR_error_string 3"
141 .TH ERR_error_string 3 "0.9.6e" "2000-11-12" "OpenSSL"
144 ERR_error_string, ERR_error_string_n, ERR_lib_error_string,
145 ERR_func_error_string, ERR_reason_error_string \- obtain human-readable
148 .IX Header "SYNOPSIS"
150 \& #include <openssl/err.h>
153 \& char *ERR_error_string(unsigned long e, char *buf);
154 \& char *ERR_error_string_n(unsigned long e, char *buf, size_t len);
157 \& const char *ERR_lib_error_string(unsigned long e);
158 \& const char *ERR_func_error_string(unsigned long e);
159 \& const char *ERR_reason_error_string(unsigned long e);
162 .IX Header "DESCRIPTION"
163 \&\fIERR_error_string()\fR generates a human-readable string representing the
164 error code \fIe\fR, and places it at \fIbuf\fR. \fIbuf\fR must be at least 120
165 bytes long. If \fIbuf\fR is \fB\s-1NULL\s0\fR, the error string is placed in a
167 \&\fIERR_error_string_n()\fR is a variant of \fIERR_error_string()\fR that writes
168 at most \fIlen\fR characters (including the terminating 0)
169 and truncates the string if necessary.
170 For \fIERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR.
172 The string will have the following format:
175 \& error:[error code]:[library name]:[function name]:[reason string]
177 \&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR,
178 \&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text.
180 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
181 \&\fIERR_reason_error_string()\fR return the library name, function
182 name and reason string respectively.
184 The OpenSSL error strings should be loaded by calling
185 ERR_load_crypto_strings(3) or, for \s-1SSL\s0
186 applications, SSL_load_error_strings(3)
188 If there is no text string registered for the given error code,
189 the error string will contain the numeric code.
191 ERR_print_errors(3) can be used to print
192 all error codes currently in the queue.
194 .IX Header "RETURN VALUES"
195 \&\fIERR_error_string()\fR returns a pointer to a static buffer containing the
196 string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise.
198 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
199 \&\fIERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if
200 none is registered for the error code.
202 .IX Header "SEE ALSO"
203 err(3), ERR_get_error(3),
204 ERR_load_crypto_strings(3),
205 SSL_load_error_strings(3)
209 \&\fIERR_error_string()\fR is available in all versions of SSLeay and OpenSSL.
210 \&\fIERR_error_string_n()\fR was added in OpenSSL 0.9.6.