doc/crypto/ERR_GET_LIB.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON - get library, function and
   6 reason code
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/err.h>
  11
  12  int ERR_GET_LIB(unsigned long e);
  13
  14  int ERR_GET_FUNC(unsigned long e);
  15
  16  int ERR_GET_REASON(unsigned long e);
  17
  18 =head1 DESCRIPTION
  19
  20 The error code returned by ERR_get_error() consists of a library
  21 number, function code and reason code. ERR_GET_LIB(), ERR_GET_FUNC()
  22 and ERR_GET_REASON() can be used to extract these.
  23
  24 The library number and function code describe where the error
  25 occurred, the reason code is the information about what went wrong.
  26
  27 Each sub-library of OpenSSL has a unique library number; function and
  28 reason codes are unique within each sub-library.  Note that different
  29 libraries may use the same value to signal different functions and
  30 reasons.
  31
  32 B<ERR_R_...> reason codes such as B<ERR_R_MALLOC_FAILURE> are globally
  33 unique. However, when checking for sub-library specific reason codes,
  34 be sure to also compare the library number.
  35
  36 ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are macros.
  37
  38 =head1 RETURN VALUES
  39
  40 The library number, function code and reason code respectively.
  41
  42 =head1 SEE ALSO
  43
  44 L<err(3)|err(3)>, L<ERR_get_error(3)|ERR_get_error(3)>
  45
  46 =head1 HISTORY
  47
  48 ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are available in
  49 all versions of SSLeay and OpenSSL.
  50
  51 =cut