From 01f49d5c8dc04c7108d0540dcc1d0134b5ed781b Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Fri, 16 Dec 2016 08:53:30 +0000 Subject: Document ERR_FATAL_ERROR(3), tweaked by me. OpenSSL commit 036ba500f7886ca2e7231549fa574ec2cdd45cef Author: Benjamin Kaduk Date: Thu Dec 8 12:01:31 2016 -0600 --- src/lib/libcrypto/man/ERR_GET_LIB.3 | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) (limited to 'src/lib') diff --git a/src/lib/libcrypto/man/ERR_GET_LIB.3 b/src/lib/libcrypto/man/ERR_GET_LIB.3 index d67e8bdde6..03f56c09f6 100644 --- a/src/lib/libcrypto/man/ERR_GET_LIB.3 +++ b/src/lib/libcrypto/man/ERR_GET_LIB.3 @@ -1,5 +1,5 @@ -.\" $OpenBSD: ERR_GET_LIB.3,v 1.4 2016/11/23 17:59:29 schwarze Exp $ -.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 +.\" $OpenBSD: ERR_GET_LIB.3,v 1.5 2016/12/16 08:53:30 schwarze Exp $ +.\" OpenSSL doc/man3/ERR_GET_LIB.pod 3dfda1a6 Dec 12 11:14:40 2016 -0500 .\" .\" This file was written by Ulf Moeller . .\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. @@ -48,13 +48,14 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: November 23 2016 $ +.Dd $Mdocdate: December 16 2016 $ .Dt ERR_GET_LIB 3 .Os .Sh NAME .Nm ERR_GET_LIB , .Nm ERR_GET_FUNC , -.Nm ERR_GET_REASON +.Nm ERR_GET_REASON , +.Nm ERR_FATAL_ERROR .Nd get library, function and reason codes for OpenSSL errors .Sh SYNOPSIS .In openssl/err.h @@ -70,6 +71,10 @@ .Fo ERR_GET_REASON .Fa "unsigned long e" .Fc +.Ft int +.Fo ERR_FATAL_ERROR +.Fa "unsigned long e" +.Fc .Sh DESCRIPTION The error code returned by .Xr ERR_get_error 3 @@ -95,13 +100,19 @@ are globally unique. However, when checking for sub-library specific reason codes, be sure to also compare the library number. .Pp +.Fn ERR_FATAL_ERROR +indicates whether a given error code is a fatal error. +.Pp +These functions are implemented as macros. +.Sh RETURN VALUES .Fn ERR_GET_LIB , .Fn ERR_GET_FUNC , and .Fn ERR_GET_REASON -are macros. -.Sh RETURN VALUES -The library number, function code, and reason code, respectively. +return the library number, function code, and reason code, respectively. +.Pp +.Fn ERR_FATAL_ERROR +returns non-zero if the error is fatal or 0 otherwise. .Sh SEE ALSO .Xr ERR 3 , .Xr ERR_get_error 3 -- cgit v1.2.3-55-g6feb