ERR_load_strings.3ossl - Man Page

load arbitrary error strings

Synopsis

 #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);

Description

ERR_load_strings() registers error strings for library number lib.

str is an array of error string data:

 typedef struct ERR_string_data_st
 {
     unsigned long error;
     char *string;
 } ERR_STRING_DATA;

The error code is generated from the library number and a function and reason code: error = ERR_PACK(lib, func, reason). ERR_PACK() is a macro.

The last entry in the array is {0,0}.

ERR_get_next_error_library() can be used to assign library numbers to user libraries at run time.

Return Values

ERR_load_strings() returns 1 for success and 0 for failure. ERR_PACK() returns the error code. ERR_get_next_error_library() returns zero on failure, otherwise a new library number.

See Also

ERR_load_strings(3)

Referenced By

ERR_new.3ossl(3), ERR_put_error.3ossl(3).

The man pages ERR_get_next_error_library.3ossl(3) and ERR_PACK.3ossl(3) are aliases of ERR_load_strings.3ossl(3).

2024-04-04 3.2.1 OpenSSL