doc/man3/ERR_print_errors.pod

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