diff options
Diffstat (limited to 'deps/openssl/openssl/doc/crypto/ERR_GET_LIB.pod')
| -rw-r--r-- | deps/openssl/openssl/doc/crypto/ERR_GET_LIB.pod | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/deps/openssl/openssl/doc/crypto/ERR_GET_LIB.pod b/deps/openssl/openssl/doc/crypto/ERR_GET_LIB.pod index 2a129da036..5602a8e754 100644 --- a/deps/openssl/openssl/doc/crypto/ERR_GET_LIB.pod +++ b/deps/openssl/openssl/doc/crypto/ERR_GET_LIB.pod @@ -2,8 +2,8 @@ =head1 NAME -ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON - get library, function and -reason code +ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON, ERR_FATAL_ERROR +- get information from error codes =head1 SYNOPSIS @@ -15,12 +15,16 @@ reason code int ERR_GET_REASON(unsigned long e); + int ERR_FATAL_ERROR(unsigned long e); + =head1 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. +ERR_FATAL_ERROR() indicates whether a given error code is a fatal error. + The library number and function code describe where the error occurred, the reason code is the information about what went wrong. @@ -33,19 +37,30 @@ B<ERR_R_...> reason codes such as B<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. +ERR_GET_LIB(), ERR_GET_FUNC(), ERR_GET_REASON(), and ERR_FATAL_ERROR() + are macros. =head1 RETURN VALUES -The library number, function code and reason code respectively. +The library number, function code, reason code, and whether the error +is fatal, respectively. =head1 SEE ALSO -L<err(3)|err(3)>, L<ERR_get_error(3)|ERR_get_error(3)> +L<ERR_get_error(3)> =head1 HISTORY ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are available in -all versions of SSLeay and OpenSSL. +all versions of OpenSSL. + +=head1 COPYRIGHT + +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. =cut |