doc/man3/ERR_GET_LIB.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ERR_GET_LIB, ERR_GET_REASON, ERR_FATAL_ERROR
   6 - get information from error codes
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/err.h>
  11
  12  int ERR_GET_LIB(unsigned long e);
  13
  14  int ERR_GET_REASON(unsigned long e);
  15
  16  int ERR_FATAL_ERROR(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()
  22 and ERR_GET_REASON() can be used to extract these.
  23
  24 ERR_FATAL_ERROR() indicates whether a given error code is a fatal error.
  25
  26 The library number and function code describe where the error
  27 occurred, the reason code is the information about what went wrong.
  28
  29 Each sub-library of OpenSSL has a unique library number; function and
  30 reason codes are unique within each sub-library.  Note that different
  31 libraries may use the same value to signal different functions and
  32 reasons.
  33
  34 B<ERR_R_...> reason codes such as B<ERR_R_MALLOC_FAILURE> are globally
  35 unique. However, when checking for sub-library specific reason codes,
  36 be sure to also compare the library number.
  37
  38 ERR_GET_LIB(), ERR_GET_REASON(), and ERR_FATAL_ERROR() are macros.
  39
  40 =head1 RETURN VALUES
  41
  42 The library number, function code, reason code, and whether the error
  43 is fatal, respectively.
  44 Starting with OpenSSL 3.0.0, the function code is always set to zero.
  45
  46 =head1 SEE ALSO
  47
  48 L<ERR_get_error(3)>
  49
  50 =head1 HISTORY
  51
  52 ERR_GET_LIB() and ERR_GET_REASON() are available in all versions of OpenSSL.
  53
  54 ERR_GET_FUNC() was removed in OpenSSL 3.0.
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  59
  60 Licensed under the Apache License 2.0 (the "License").  You may not use
  61 this file except in compliance with the License.  You can obtain a copy
  62 in the file LICENSE in the source distribution or at
  63 L<https://www.openssl.org/source/license.html>.
  64
  65 =cut