projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 388f2f56 UM |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 3dfda1a6 RS |
5 | ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON, ERR_FATAL_ERROR |
| 6 | - get information from error codes | |
| 388f2f56 UM |
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 | ||
| 036ba500 BK |
18 | int ERR_FATAL_ERROR(unsigned long e); |
| 19 | ||
| 388f2f56 UM |
20 | =head1 DESCRIPTION |
| 21 | ||
| 22 | The error code returned by ERR_get_error() consists of a library | |
| 23 | number, function code and reason code. ERR_GET_LIB(), ERR_GET_FUNC() | |
| 24 | and ERR_GET_REASON() can be used to extract these. | |
| 25 | ||
| 036ba500 BK |
26 | ERR_FATAL_ERROR() indicates whether a given error code is a fatal error. |
| 27 | ||
| 388f2f56 UM |
28 | The library number and function code describe where the error |
| 29 | occurred, the reason code is the information about what went wrong. | |
| 30 | ||
| 31 | Each sub-library of OpenSSL has a unique library number; function and | |
| 32 | reason codes are unique within each sub-library. Note that different | |
| 33 | libraries may use the same value to signal different functions and | |
| 34 | reasons. | |
| 35 | ||
| 36 | B<ERR_R_...> reason codes such as B<ERR_R_MALLOC_FAILURE> are globally | |
| 37 | unique. However, when checking for sub-library specific reason codes, | |
| 38 | be sure to also compare the library number. | |
| 39 | ||
| 036ba500 | 40 | ERR_GET_LIB(), ERR_GET_FUNC(), ERR_GET_REASON(), and ERR_FATAL_ERROR() |
| aac96e27 | 41 | are macros. |
| 388f2f56 UM |
42 | |
| 43 | =head1 RETURN VALUES | |
| 44 | ||
| 036ba500 BK |
45 | The library number, function code, reason code, and whether the error |
| 46 | is fatal, respectively. | |
| aac96e27 | 47 | Starting with OpenSSL 3.0.0, the function code is always set to zero. |
| 388f2f56 UM |
48 | |
| 49 | =head1 SEE ALSO | |
| 50 | ||
| 73fb82b7 | 51 | L<ERR_get_error(3)> |
| 388f2f56 UM |
52 | |
| 53 | =head1 HISTORY | |
| 54 | ||
| 55 | ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are available in | |
| a528d4f0 | 56 | all versions of OpenSSL. |
| 388f2f56 | 57 | |
| e2f92610 RS |
58 | =head1 COPYRIGHT |
| 59 | ||
| 73fb82b7 | 60 | Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. |
| e2f92610 | 61 | |
| 4746f25a | 62 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| e2f92610 RS |
63 | this file except in compliance with the License. You can obtain a copy |
| 64 | in the file LICENSE in the source distribution or at | |
| 65 | L<https://www.openssl.org/source/license.html>. | |
| 66 | ||
| 67 | =cut |