1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
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 \
129 .\" ========================================================================
131 .IX Title "ERR_error_string 3"
132 .TH ERR_error_string 3 "2018-08-14" "1.0.2p" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 ERR_error_string, ERR_error_string_n, ERR_lib_error_string,
139 ERR_func_error_string, ERR_reason_error_string \- obtain human\-readable
142 .IX Header "SYNOPSIS"
144 \& #include <openssl/err.h>
146 \& char *ERR_error_string(unsigned long e, char *buf);
147 \& void ERR_error_string_n(unsigned long e, char *buf, size_t len);
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);
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
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.
164 The string will have the following format:
167 \& error:[error code]:[library name]:[function name]:[reason string]
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.
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.
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)
181 If there is no text string registered for the given error code,
182 the error string will contain the numeric code.
184 \&\fIERR_print_errors\fR\|(3) can be used to print
185 all error codes currently in the queue.
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.
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.
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)
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.