diff options
| author | Benjamin Kaduk <bkaduk@akamai.com> | 2016-12-08 19:01:31 +0100 |
|---|---|---|
| committer | Rich Salz <rsalz@openssl.org> | 2016-12-12 14:23:03 +0100 |
| commit | 036ba500f7886ca2e7231549fa574ec2cdd45cef (patch) | |
| tree | 4ebc0351c509c82c92171fcd84affb2c71da2d80 /doc | |
| parent | Fix a leak in SSL_clear() (diff) | |
| download | openssl-036ba500f7886ca2e7231549fa574ec2cdd45cef.tar.xz openssl-036ba500f7886ca2e7231549fa574ec2cdd45cef.zip | |
Restore the ERR_FATAL_ERROR() macro
Commit 0cd0a820abc6124cf8e176fa92d620a2abf9e419 removed this macro
along with many unused function and reason codes; ERR_FATAL_ERROR()
was not used in the tree, but did have external consumers.
Add it back to restore the API compatibility and avoid breaking
applications for no internal benefit.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2049)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/ERR_GET_LIB.pod | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/man3/ERR_GET_LIB.pod b/doc/man3/ERR_GET_LIB.pod index b93ebf608c..d809d7a54e 100644 --- a/doc/man3/ERR_GET_LIB.pod +++ b/doc/man3/ERR_GET_LIB.pod @@ -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,11 +37,13 @@ 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 |