$NetBSD: ERR_print_errors.3,v 1.25 2024/09/08 13:08:20 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "ERR_print_errors 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
ERR_print_errors, ERR_print_errors_fp, ERR_print_errors_cb \- print error messages Header "SYNOPSIS" .Vb 1 #include <openssl/err.h> \& void ERR_print_errors(BIO *bp); void ERR_print_errors_fp(FILE *fp); void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u), void *u); .Ve Header "DESCRIPTION" \fBERR_print_errors() is a convenience function that prints the error strings for all errors that OpenSSL has recorded to bp, thus emptying the error queue.

\fBERR_print_errors_fp() is the same, except that the output goes to a \fBFILE.

\fBERR_print_errors_cb() is the same, except that the callback function, \fBcb, is called for each error line with the string, length, and userdata \fBu as the callback parameters.

The error strings will have the following format:

.Vb 1 [pid]:error:[error code]:[library name]:[function name]:[reason string]:[filename]:[line]:[optional text message] .Ve

\fIerror code is an 8 digit hexadecimal number. library name, \fIfunction name and reason string are ASCII text, as is optional text message if one was set for the respective error code.

If there is no text string registered for the given error code, the error string will contain the numeric code.

Header "RETURN VALUES" \fBERR_print_errors() and ERR_print_errors_fp() return no values. Header "SEE ALSO" \fBERR_error_string\|(3), \fBERR_get_error\|(3) Header "COPYRIGHT" Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.