Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ERR_GET_LIB (3openssl)

Name

ERR_GET_LIB - get library, function and reason code

Synopsis

#include <openssl/err.h>

int ERR_GET_LIB(unsigned long e);

int ERR_GET_FUNC(unsigned long e);

int ERR_GET_REASON(unsigned long e);

Description

ERR_GET_LIB(3openssl)               OpenSSL              ERR_GET_LIB(3openssl)



NAME
       ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON - get library, function and
       reason code

SYNOPSIS
        #include <openssl/err.h>

        int ERR_GET_LIB(unsigned long e);

        int ERR_GET_FUNC(unsigned long e);

        int ERR_GET_REASON(unsigned long e);

DESCRIPTION
       The error code returned by ERR_get_error() consists of a library
       number, function code and reason code. ERR_GET_LIB(), ERR_GET_FUNC()
       and ERR_GET_REASON() can be used to extract these.

       The library number and function code describe where the error occurred,
       the reason code is the information about what went wrong.

       Each sub-library of OpenSSL has a unique library number; function and
       reason codes are unique within each sub-library.  Note that different
       libraries may use the same value to signal different functions and
       reasons.

       ERR_R_... reason codes such as ERR_R_MALLOC_FAILURE are globally
       unique. However, when checking for sub-library specific reason codes,
       be sure to also compare the library number.

       ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are macros.

RETURN VALUES
       The library number, function code and reason code respectively.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       err(3), ERR_get_error(3)

HISTORY
       ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are available in all
       versions of SSLeay and OpenSSL.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.



1.0.2ze                           2022-05-03             ERR_GET_LIB(3openssl)