1.\" $OpenBSD: ERR_load_strings.3,v 1.8 2024/07/26 03:40:43 tb Exp $ 2.\" OpenSSL 05ea606a May 20 20:52:46 2016 -0400 3.\" 4.\" This file was written by Ulf Moeller <ulf@openssl.org>. 5.\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: July 26 2024 $ 52.Dt ERR_LOAD_STRINGS 3 53.Os 54.Sh NAME 55.Nm ERR_load_strings , 56.Nm ERR_PACK , 57.Nm ERR_get_next_error_library 58.Nd load arbitrary OpenSSL error strings 59.Sh SYNOPSIS 60.In openssl/err.h 61.Ft void 62.Fo ERR_load_strings 63.Fa "int lib" 64.Fa "ERR_STRING_DATA str[]" 65.Fc 66.Ft unsigned long 67.Fo ERR_PACK 68.Fa "int lib" 69.Fa "int func" 70.Fa "int reason" 71.Fc 72.Ft int 73.Fn ERR_get_next_error_library void 74.Sh DESCRIPTION 75.Fn ERR_load_strings 76registers error strings for library number 77.Fa lib . 78.Pp 79.Fa str 80is an array of error string data: 81.Bd -literal -offset indent 82typedef struct ERR_string_data_st { 83 unsigned long error; 84 char *string; 85} ERR_STRING_DATA; 86.Ed 87.Pp 88The error code is generated from the library number and a function and 89reason code: 90.Pp 91.Dl error = ERR_PACK(lib, func, reason) 92.Pp 93.Fn ERR_PACK 94is a macro. 95.Pp 96The last entry in the array is 97.Brq 0 , Dv NULL . 98.Pp 99.Fn ERR_get_next_error_library 100can be used to assign library numbers to user libraries at runtime. 101.Sh RETURN VALUES 102.Fn ERR_PACK 103returns the error code. 104.Fn ERR_get_next_error_library 105returns a new library number. 106.Sh SEE ALSO 107.Xr ERR 3 108.Sh HISTORY 109.Fn ERR_load_strings 110and 111.Fn ERR_PACK 112first appeared in SSLeay 0.4.4. 113.Fn ERR_get_next_error_library 114first appeared in SSLeay 0.9.0. 115These functions have been available since 116.Ox 2.4 . 117