Local adjustments for OpenSSL-1.0.1p.
[dragonfly.git] / secure / lib / libcrypto / man / ERR_error_string.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
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<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
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
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, 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.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "ERR_error_string 3"
136 .TH ERR_error_string 3 "2015-07-09" "1.0.1p" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 ERR_error_string, ERR_error_string_n, ERR_lib_error_string,
143 ERR_func_error_string, ERR_reason_error_string \- obtain human\-readable
144 error message
145 .SH "SYNOPSIS"
146 .IX Header "SYNOPSIS"
147 .Vb 1
148 \& #include <openssl/err.h>
149 \&
150 \& char *ERR_error_string(unsigned long e, char *buf);
151 \& void ERR_error_string_n(unsigned long e, char *buf, size_t len);
152 \&
153 \& const char *ERR_lib_error_string(unsigned long e);
154 \& const char *ERR_func_error_string(unsigned long e);
155 \& const char *ERR_reason_error_string(unsigned long e);
156 .Ve
157 .SH "DESCRIPTION"
158 .IX Header "DESCRIPTION"
159 \&\fIERR_error_string()\fR generates a human-readable string representing the
160 error code \fIe\fR, and places it at \fIbuf\fR. \fIbuf\fR must be at least 120
161 bytes long. If \fIbuf\fR is \fB\s-1NULL\s0\fR, the error string is placed in a
162 static buffer.
163 \&\fIERR_error_string_n()\fR is a variant of \fIERR_error_string()\fR that writes
164 at most \fIlen\fR characters (including the terminating 0)
165 and truncates the string if necessary.
166 For \fIERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR.
167 .PP
168 The string will have the following format:
169 .PP
170 .Vb 1
171 \& error:[error code]:[library name]:[function name]:[reason string]
172 .Ve
173 .PP
174 \&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR,
175 \&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text.
176 .PP
177 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
178 \&\fIERR_reason_error_string()\fR return the library name, function
179 name and reason string respectively.
180 .PP
181 The OpenSSL error strings should be loaded by calling
182 \&\fIERR_load_crypto_strings\fR\|(3) or, for \s-1SSL\s0
183 applications, \fISSL_load_error_strings\fR\|(3)
184 first.
185 If there is no text string registered for the given error code,
186 the error string will contain the numeric code.
187 .PP
188 \&\fIERR_print_errors\fR\|(3) can be used to print
189 all error codes currently in the queue.
190 .SH "RETURN VALUES"
191 .IX Header "RETURN VALUES"
192 \&\fIERR_error_string()\fR returns a pointer to a static buffer containing the
193 string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise.
194 .PP
195 \&\fIERR_lib_error_string()\fR, \fIERR_func_error_string()\fR and
196 \&\fIERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if
197 none is registered for the error code.
198 .SH "SEE ALSO"
199 .IX Header "SEE ALSO"
200 \&\fIerr\fR\|(3), \fIERR_get_error\fR\|(3),
201 \&\fIERR_load_crypto_strings\fR\|(3),
202 \&\fISSL_load_error_strings\fR\|(3)
203 \&\fIERR_print_errors\fR\|(3)
204 .SH "HISTORY"
205 .IX Header "HISTORY"
206 \&\fIERR_error_string()\fR is available in all versions of SSLeay and OpenSSL.
207 \&\fIERR_error_string_n()\fR was added in OpenSSL 0.9.6.