xref: /freebsd/crypto/openssl/doc/man3/ERR_print_errors.pod (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1=pod
2
3=head1 NAME
4
5ERR_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
19ERR_print_errors() is a convenience function that prints the error
20strings for all errors that OpenSSL has recorded to B<bp>, thus
21emptying the error queue.
22
23ERR_print_errors_fp() is the same, except that the output goes to a
24B<FILE>.
25
26ERR_print_errors_cb() is the same, except that the callback function,
27B<cb>, is called for each error line with the string, length, and userdata
28B<u> as the callback parameters.
29
30The 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
34I<error code> is an 8 digit hexadecimal number. I<library name>,
35I<function name> and I<reason string> are ASCII text, as is I<optional
36text message> if one was set for the respective error code.
37
38If there is no text string registered for the given error code,
39the error string will contain the numeric code.
40
41=head1 RETURN VALUES
42
43ERR_print_errors() and ERR_print_errors_fp() return no values.
44
45=head1 SEE ALSO
46
47L<ERR_error_string(3)>,
48L<ERR_get_error(3)>
49
50=head1 COPYRIGHT
51
52Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
53
54Licensed under the OpenSSL license (the "License").  You may not use
55this file except in compliance with the License.  You can obtain a copy
56in the file LICENSE in the source distribution or at
57L<https://www.openssl.org/source/license.html>.
58
59=cut
60