$NetBSD: ERR_load_strings.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:
========================================================================
..
. 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_load_strings 3"
way too many mistakes in technical documents.
-*- 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_load_strings 3"
ERR_load_strings 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
NAME
ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
arbitrary error strings
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <openssl/err.h>
\&
int ERR_load_strings(int lib, ERR_STRING_DATA *str);
\&
int ERR_get_next_error_library(void);
\&
unsigned long ERR_PACK(int lib, int func, int reason);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBERR_load_strings() registers error strings for library number lib.
\fBstr is an array of error string data:
.Vb 5 typedef struct ERR_string_data_st { unsigned long error; char *string; } ERR_STRING_DATA; .Ve
The error code is generated from the library number and a function and reason code: error = ERR_PACK(lib, func, reason). \fBERR_PACK() is a macro.
The last entry in the array is {0,0}.
\fBERR_get_next_error_library() can be used to assign library numbers to user libraries at run time.
"RETURN VALUES"
Header "RETURN VALUES" \fBERR_load_strings() returns 1 for success and 0 for failure. ERR_PACK() returns the error code.
\fBERR_get_next_error_library() returns zero on failure, otherwise a new
library number.
"SEE ALSO"
Header "SEE ALSO" \fBERR_load_strings\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-2021 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>.