]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/crypto/ERR_print_errors.pod
Avoid using latest clang since repo not available
[thirdparty/openssl.git] / doc / crypto / ERR_print_errors.pod
CommitLineData
388f2f56
UM
1=pod
2
3=head1 NAME
4
5ERR_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
16ERR_print_errors() is a convenience function that prints the error
17strings for all errors that OpenSSL has recorded to B<bp>, thus
18emptying the error queue.
19
20ERR_print_errors_fp() is the same, except that the output goes to a
21B<FILE>.
22
23
24The 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
28I<error code> is an 8 digit hexadecimal number. I<library name>,
29I<function name> and I<reason string> are ASCII text, as is I<optional
30text message> if one was set for the respective error code.
31
32If there is no text string registered for the given error code,
33the error string will contain the numeric code.
34
35=head1 RETURN VALUES
36
37ERR_print_errors() and ERR_print_errors_fp() return no values.
38
39=head1 SEE ALSO
40
9b86974e 41L<err(3)>, L<ERR_error_string(3)>,
f672aee4 42L<ERR_get_error(3)>.
388f2f56 43
e2f92610
RS
44=head1 COPYRIGHT
45
46Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
47
48Licensed under the OpenSSL license (the "License"). You may not use
49this file except in compliance with the License. You can obtain a copy
50in the file LICENSE in the source distribution or at
51L<https://www.openssl.org/source/license.html>.
52
53=cut