5 ERR_error_string, ERR_error_string_n, ERR_lib_error_string,
6 ERR_func_error_string, ERR_reason_error_string - obtain human-readable
11 #include <openssl/err.h>
13 char *ERR_error_string(unsigned long e, char *buf);
14 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
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);
22 ERR_error_string() generates a human-readable string representing the
23 error code I<e>, and places it at I<buf>. I<buf> must be at least 256
24 bytes long. If I<buf> is B<NULL>, the error string is placed in a
26 Note that this function is not thread-safe and does no checks on the size
27 of the buffer; use ERR_error_string_n() instead.
29 ERR_error_string_n() is a variant of ERR_error_string() that writes
30 at most I<len> characters (including the terminating 0)
31 and truncates the string if necessary.
32 For ERR_error_string_n(), I<buf> may not be B<NULL>.
34 The string will have the following format:
36 error:[error code]:[library name]:[function name]:[reason string]
38 I<error code> is an 8 digit hexadecimal number, I<library name>,
39 I<function name> and I<reason string> are ASCII text.
41 ERR_lib_error_string(), ERR_func_error_string() and
42 ERR_reason_error_string() return the library name, function
43 name and reason string respectively.
45 If there is no text string registered for the given error code,
46 the error string will contain the numeric code.
48 L<ERR_print_errors(3)> can be used to print
49 all error codes currently in the queue.
53 ERR_error_string() returns a pointer to a static buffer containing the
54 string if I<buf> B<== NULL>, I<buf> otherwise.
56 ERR_lib_error_string(), ERR_func_error_string() and
57 ERR_reason_error_string() return the strings, and B<NULL> if
58 none is registered for the error code.
63 L<ERR_print_errors(3)>
67 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
69 Licensed under the Apache License 2.0 (the "License"). You may not use
70 this file except in compliance with the License. You can obtain a copy
71 in the file LICENSE in the source distribution or at
72 L<https://www.openssl.org/source/license.html>.