| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | ERR_print_errors, ERR_print_errors_fp, ERR_print_errors_cb
|
|---|
| 6 | - print error messages
|
|---|
| 7 |
|
|---|
| 8 | =head1 SYNOPSIS
|
|---|
| 9 |
|
|---|
| 10 | #include <openssl/err.h>
|
|---|
| 11 |
|
|---|
| 12 | void ERR_print_errors(BIO *bp);
|
|---|
| 13 | void ERR_print_errors_fp(FILE *fp);
|
|---|
| 14 | void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u), void *u)
|
|---|
| 15 |
|
|---|
| 16 |
|
|---|
| 17 | =head1 DESCRIPTION
|
|---|
| 18 |
|
|---|
| 19 | ERR_print_errors() is a convenience function that prints the error
|
|---|
| 20 | strings for all errors that OpenSSL has recorded to B<bp>, thus
|
|---|
| 21 | emptying the error queue.
|
|---|
| 22 |
|
|---|
| 23 | ERR_print_errors_fp() is the same, except that the output goes to a
|
|---|
| 24 | B<FILE>.
|
|---|
| 25 |
|
|---|
| 26 | ERR_print_errors_cb() is the same, except that the callback function,
|
|---|
| 27 | B<cb>, is called for each error line with the string, length, and userdata
|
|---|
| 28 | B<u> as the callback parameters.
|
|---|
| 29 |
|
|---|
| 30 | The error strings will have the following format:
|
|---|
| 31 |
|
|---|
| 32 | [pid]:error:[error code]:[library name]:[function name]:[reason string]:[filename]:[line]:[optional text message]
|
|---|
| 33 |
|
|---|
| 34 | I<error code> is an 8 digit hexadecimal number. I<library name>,
|
|---|
| 35 | I<function name> and I<reason string> are ASCII text, as is I<optional
|
|---|
| 36 | text message> if one was set for the respective error code.
|
|---|
| 37 |
|
|---|
| 38 | If there is no text string registered for the given error code,
|
|---|
| 39 | the error string will contain the numeric code.
|
|---|
| 40 |
|
|---|
| 41 | =head1 RETURN VALUES
|
|---|
| 42 |
|
|---|
| 43 | ERR_print_errors() and ERR_print_errors_fp() return no values.
|
|---|
| 44 |
|
|---|
| 45 | =head1 SEE ALSO
|
|---|
| 46 |
|
|---|
| 47 | L<ERR_error_string(3)>,
|
|---|
| 48 | L<ERR_get_error(3)>
|
|---|
| 49 |
|
|---|
| 50 | =head1 COPYRIGHT
|
|---|
| 51 |
|
|---|
| 52 | Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 53 |
|
|---|
| 54 | Licensed under the OpenSSL license (the "License"). You may not use
|
|---|
| 55 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 56 | in the file LICENSE in the source distribution or at
|
|---|
| 57 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 58 |
|
|---|
| 59 | =cut
|
|---|
