diff options
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_print_errors.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/ERR_print_errors.pod | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/ERR_print_errors.pod b/src/lib/libcrypto/doc/ERR_print_errors.pod new file mode 100644 index 0000000000..b100a5fa2b --- /dev/null +++ b/src/lib/libcrypto/doc/ERR_print_errors.pod | |||
| @@ -0,0 +1,51 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | ERR_print_errors, ERR_print_errors_fp - print error messages | ||
| 6 | |||
| 7 | =head1 SYNOPSIS | ||
| 8 | |||
| 9 | #include <openssl/err.h> | ||
| 10 | |||
| 11 | void ERR_print_errors(BIO *bp); | ||
| 12 | void ERR_print_errors_fp(FILE *fp); | ||
| 13 | |||
| 14 | =head1 DESCRIPTION | ||
| 15 | |||
| 16 | ERR_print_errors() is a convenience function that prints the error | ||
| 17 | strings for all errors that OpenSSL has recorded to B<bp>, thus | ||
| 18 | emptying the error queue. | ||
| 19 | |||
| 20 | ERR_print_errors_fp() is the same, except that the output goes to a | ||
| 21 | B<FILE>. | ||
| 22 | |||
| 23 | |||
| 24 | The error strings will have the following format: | ||
| 25 | |||
| 26 | [pid]:error:[error code]:[library name]:[function name]:[reason string]:[file name]:[line]:[optional text message] | ||
| 27 | |||
| 28 | I<error code> is an 8 digit hexadecimal number. I<library name>, | ||
| 29 | I<function name> and I<reason string> are ASCII text, as is I<optional | ||
| 30 | text message> if one was set for the respective error code. | ||
| 31 | |||
| 32 | If there is no text string registered for the given error code, | ||
| 33 | the error string will contain the numeric code. | ||
| 34 | |||
| 35 | =head1 RETURN VALUES | ||
| 36 | |||
| 37 | ERR_print_errors() and ERR_print_errors_fp() return no values. | ||
| 38 | |||
| 39 | =head1 SEE ALSO | ||
| 40 | |||
| 41 | L<err(3)|err(3)>, L<ERR_error_string(3)|ERR_error_string(3)>, | ||
| 42 | L<ERR_get_error(3)|ERR_get_error(3)>, | ||
| 43 | L<ERR_load_crypto_strings(3)|ERR_load_crypto_strings(3)>, | ||
| 44 | L<SSL_load_error_strings(3)|SSL_load_error_strings(3)> | ||
| 45 | |||
| 46 | =head1 HISTORY | ||
| 47 | |||
| 48 | ERR_print_errors() and ERR_print_errors_fp() | ||
| 49 | are available in all versions of SSLeay and OpenSSL. | ||
| 50 | |||
| 51 | =cut | ||
