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