]>
Commit | Line | Data |
---|---|---|
388f2f56 UM |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
e1b78bc6 RL |
5 | ERR_error_string, ERR_error_string_n, ERR_lib_error_string, |
6 | ERR_func_error_string, ERR_reason_error_string - obtain human-readable | |
7 | error message | |
388f2f56 UM |
8 | |
9 | =head1 SYNOPSIS | |
10 | ||
11 | #include <openssl/err.h> | |
12 | ||
13 | char *ERR_error_string(unsigned long e, char *buf); | |
4451c255 | 14 | void ERR_error_string_n(unsigned long e, char *buf, size_t len); |
388f2f56 UM |
15 | |
16 | const char *ERR_lib_error_string(unsigned long e); | |
17 | const char *ERR_func_error_string(unsigned long e); | |
18 | const char *ERR_reason_error_string(unsigned long e); | |
19 | ||
20 | =head1 DESCRIPTION | |
21 | ||
22 | ERR_error_string() generates a human-readable string representing the | |
e5c84d51 BM |
23 | error code I<e>, and places it at I<buf>. I<buf> must be at least 120 |
24 | bytes long. If I<buf> is B<NULL>, the error string is placed in a | |
388f2f56 | 25 | static buffer. |
e5c84d51 BM |
26 | ERR_error_string_n() is a variant of ERR_error_string() that writes |
27 | at most I<len> characters (including the terminating 0) | |
2c8c4ce2 | 28 | and truncates the string if necessary. |
e5c84d51 | 29 | For ERR_error_string_n(), I<buf> may not be B<NULL>. |
388f2f56 UM |
30 | |
31 | The string will have the following format: | |
32 | ||
33 | error:[error code]:[library name]:[function name]:[reason string] | |
34 | ||
35 | I<error code> is an 8 digit hexadecimal number, I<library name>, | |
36 | I<function name> and I<reason string> are ASCII text. | |
37 | ||
38 | ERR_lib_error_string(), ERR_func_error_string() and | |
39 | ERR_reason_error_string() return the library name, function | |
40 | name and reason string respectively. | |
41 | ||
42 | The OpenSSL error strings should be loaded by calling | |
9b86974e RS |
43 | L<ERR_load_crypto_strings(3)> or, for SSL |
44 | applications, L<SSL_load_error_strings(3)> | |
388f2f56 UM |
45 | first. |
46 | If there is no text string registered for the given error code, | |
47 | the error string will contain the numeric code. | |
48 | ||
9b86974e | 49 | L<ERR_print_errors(3)> can be used to print |
388f2f56 UM |
50 | all error codes currently in the queue. |
51 | ||
52 | =head1 RETURN VALUES | |
53 | ||
54 | ERR_error_string() returns a pointer to a static buffer containing the | |
e5c84d51 | 55 | string if I<buf> B<== NULL>, I<buf> otherwise. |
388f2f56 UM |
56 | |
57 | ERR_lib_error_string(), ERR_func_error_string() and | |
58 | ERR_reason_error_string() return the strings, and B<NULL> if | |
59 | none is registered for the error code. | |
60 | ||
61 | =head1 SEE ALSO | |
62 | ||
9b86974e RS |
63 | L<err(3)>, L<ERR_get_error(3)>, |
64 | L<ERR_load_crypto_strings(3)>, | |
65 | L<SSL_load_error_strings(3)> | |
66 | L<ERR_print_errors(3)> | |
388f2f56 UM |
67 | |
68 | =head1 HISTORY | |
69 | ||
70 | ERR_error_string() is available in all versions of SSLeay and OpenSSL. | |
e5c84d51 | 71 | ERR_error_string_n() was added in OpenSSL 0.9.6. |
388f2f56 UM |
72 | |
73 | =cut |