xref: /onnv-gate/usr/src/common/openssl/doc/crypto/ERR_print_errors.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948ERR_print_errors, ERR_print_errors_fp - print error messages
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/err.h>
10*2175Sjp161948
11*2175Sjp161948 void ERR_print_errors(BIO *bp);
12*2175Sjp161948 void ERR_print_errors_fp(FILE *fp);
13*2175Sjp161948
14*2175Sjp161948=head1 DESCRIPTION
15*2175Sjp161948
16*2175Sjp161948ERR_print_errors() is a convenience function that prints the error
17*2175Sjp161948strings for all errors that OpenSSL has recorded to B<bp>, thus
18*2175Sjp161948emptying the error queue.
19*2175Sjp161948
20*2175Sjp161948ERR_print_errors_fp() is the same, except that the output goes to a
21*2175Sjp161948B<FILE>.
22*2175Sjp161948
23*2175Sjp161948
24*2175Sjp161948The error strings will have the following format:
25*2175Sjp161948
26*2175Sjp161948 [pid]:error:[error code]:[library name]:[function name]:[reason string]:[file name]:[line]:[optional text message]
27*2175Sjp161948
28*2175Sjp161948I<error code> is an 8 digit hexadecimal number. I<library name>,
29*2175Sjp161948I<function name> and I<reason string> are ASCII text, as is I<optional
30*2175Sjp161948text message> if one was set for the respective error code.
31*2175Sjp161948
32*2175Sjp161948If there is no text string registered for the given error code,
33*2175Sjp161948the error string will contain the numeric code.
34*2175Sjp161948
35*2175Sjp161948=head1 RETURN VALUES
36*2175Sjp161948
37*2175Sjp161948ERR_print_errors() and ERR_print_errors_fp() return no values.
38*2175Sjp161948
39*2175Sjp161948=head1 SEE ALSO
40*2175Sjp161948
41*2175Sjp161948L<err(3)|err(3)>, L<ERR_error_string(3)|ERR_error_string(3)>,
42*2175Sjp161948L<ERR_get_error(3)|ERR_get_error(3)>,
43*2175Sjp161948L<ERR_load_crypto_strings(3)|ERR_load_crypto_strings(3)>,
44*2175Sjp161948L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>
45*2175Sjp161948
46*2175Sjp161948=head1 HISTORY
47*2175Sjp161948
48*2175Sjp161948ERR_print_errors() and ERR_print_errors_fp()
49*2175Sjp161948are available in all versions of SSLeay and OpenSSL.
50*2175Sjp161948
51*2175Sjp161948=cut
52