diff options
Diffstat (limited to 'src/lib/libcrypto/man/ERR_print_errors.3')
| -rw-r--r-- | src/lib/libcrypto/man/ERR_print_errors.3 | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/ERR_print_errors.3 b/src/lib/libcrypto/man/ERR_print_errors.3 new file mode 100644 index 0000000000..1fc80d93f7 --- /dev/null +++ b/src/lib/libcrypto/man/ERR_print_errors.3 | |||
| @@ -0,0 +1,57 @@ | |||
| 1 | .Dd $Mdocdate: November 2 2016 $ | ||
| 2 | .Dt ERR_PRINT_ERRORS 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm ERR_print_errors , | ||
| 6 | .Nm ERR_print_errors_fp | ||
| 7 | .Nd print OpenSSL error messages | ||
| 8 | .Sh SYNOPSIS | ||
| 9 | .In openssl/err.h | ||
| 10 | .Ft void | ||
| 11 | .Fo ERR_print_errors | ||
| 12 | .Fa "BIO *bp" | ||
| 13 | .Fc | ||
| 14 | .Ft void | ||
| 15 | .Fo ERR_print_errors_fp | ||
| 16 | .Fa "FILE *fp" | ||
| 17 | .Fc | ||
| 18 | .Sh DESCRIPTION | ||
| 19 | .Fn ERR_print_errors | ||
| 20 | is a convenience function that prints the error strings for all errors | ||
| 21 | that OpenSSL has recorded to | ||
| 22 | .Fa bp , | ||
| 23 | thus emptying the error queue. | ||
| 24 | .Pp | ||
| 25 | .Fn ERR_print_errors_fp | ||
| 26 | is the same, except that the output goes to a | ||
| 27 | .Vt FILE . | ||
| 28 | .Pp | ||
| 29 | The error strings have the following format: | ||
| 30 | .Bd -literal | ||
| 31 | [pid]:error:[error code]:[library name]:[function name]:[reason string]: | ||
| 32 | [file name]:[line]:[optional text message] | ||
| 33 | .Ed | ||
| 34 | .Pp | ||
| 35 | The error code is an 8 digit hexadecimal number. | ||
| 36 | The library name, the function name, and the reason string are ASCII | ||
| 37 | text, as is the optional text message if one was set for the | ||
| 38 | respective error code. | ||
| 39 | .Pp | ||
| 40 | If there is no text string registered for the given error code, the | ||
| 41 | error string will contain the numeric code. | ||
| 42 | .Sh RETURN VALUES | ||
| 43 | .Fn ERR_print_errors | ||
| 44 | and | ||
| 45 | .Fn ERR_print_errors_fp | ||
| 46 | return no values. | ||
| 47 | .Sh SEE ALSO | ||
| 48 | .Xr ERR 3 , | ||
| 49 | .Xr ERR_error_string 3 , | ||
| 50 | .Xr ERR_get_error 3 , | ||
| 51 | .Xr ERR_load_crypto_strings 3 , | ||
| 52 | .Xr SSL_load_error_strings 3 | ||
| 53 | .Sh HISTORY | ||
| 54 | .Fn ERR_print_errors | ||
| 55 | and | ||
| 56 | .Fn ERR_print_errors_fp | ||
| 57 | are available in all versions of SSLeay and OpenSSL. | ||
