ERR_print_errors.pod 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. =pod
  2. =head1 NAME
  3. ERR_print_errors, ERR_print_errors_fp - print error messages
  4. =head1 SYNOPSIS
  5. #include <openssl/err.h>
  6. void ERR_print_errors(BIO *bp);
  7. void ERR_print_errors_fp(FILE *fp);
  8. =head1 DESCRIPTION
  9. ERR_print_errors() is a convenience function that prints the error
  10. strings for all errors that OpenSSL has recorded to B<bp>, thus
  11. emptying the error queue.
  12. ERR_print_errors_fp() is the same, except that the output goes to a
  13. B<FILE>.
  14. The error strings will have the following format:
  15. [pid]:error:[error code]:[library name]:[function name]:[reason string]:[file name]:[line]:[optional text message]
  16. I<error code> is an 8 digit hexadecimal number. I<library name>,
  17. I<function name> and I<reason string> are ASCII text, as is I<optional
  18. text message> if one was set for the respective error code.
  19. If there is no text string registered for the given error code,
  20. the error string will contain the numeric code.
  21. =head1 RETURN VALUES
  22. ERR_print_errors() and ERR_print_errors_fp() return no values.
  23. =head1 SEE ALSO
  24. L<err(3)|err(3)>, L<ERR_error_string(3)|ERR_error_string(3)>,
  25. L<ERR_get_error(3)|ERR_get_error(3)>,
  26. L<ERR_load_crypto_strings(3)|ERR_load_crypto_strings(3)>,
  27. L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>
  28. =head1 HISTORY
  29. ERR_print_errors() and ERR_print_errors_fp()
  30. are available in all versions of SSLeay and OpenSSL.
  31. =cut