1.\" $OpenBSD: ERR_GET_LIB.3,v 1.7 2018/03/27 17:35:50 schwarze Exp $ 2.\" OpenSSL doc/man3/ERR_GET_LIB.pod 3dfda1a6 Dec 12 11:14:40 2016 -0500 3.\" 4.\" This file was written by Ulf Moeller <ulf@openssl.org>. 5.\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: March 27 2018 $ 52.Dt ERR_GET_LIB 3 53.Os 54.Sh NAME 55.Nm ERR_GET_LIB , 56.Nm ERR_GET_FUNC , 57.Nm ERR_GET_REASON , 58.Nm ERR_FATAL_ERROR 59.Nd get library, function and reason codes for OpenSSL errors 60.Sh SYNOPSIS 61.In openssl/err.h 62.Ft int 63.Fo ERR_GET_LIB 64.Fa "unsigned long e" 65.Fc 66.Ft int 67.Fo ERR_GET_FUNC 68.Fa "unsigned long e" 69.Fc 70.Ft int 71.Fo ERR_GET_REASON 72.Fa "unsigned long e" 73.Fc 74.Ft int 75.Fo ERR_FATAL_ERROR 76.Fa "unsigned long e" 77.Fc 78.Sh DESCRIPTION 79The error code returned by 80.Xr ERR_get_error 3 81consists of a library number, function code, and reason code. 82.Fn ERR_GET_LIB , 83.Fn ERR_GET_FUNC , 84and 85.Fn ERR_GET_REASON 86can be used to extract these. 87.Pp 88The library number and function code describe where the error occurred, 89whereas the reason code is the information about what went wrong. 90.Pp 91Each sub-library of OpenSSL has a unique library number; function and 92reason codes are unique within each sub-library. 93Note that different libraries may use the same value to signal different 94functions and reasons. 95.Pp 96.Dv ERR_R_* 97reason codes such as 98.Dv ERR_R_MALLOC_FAILURE 99are globally unique. 100However, when checking for sub-library specific reason codes, be sure to 101also compare the library number. 102.Pp 103.Fn ERR_FATAL_ERROR 104indicates whether a given error code is a fatal error. 105.Pp 106These functions are implemented as macros. 107.Sh RETURN VALUES 108.Fn ERR_GET_LIB , 109.Fn ERR_GET_FUNC , 110and 111.Fn ERR_GET_REASON 112return the library number, function code, and reason code, respectively. 113.Pp 114.Fn ERR_FATAL_ERROR 115returns non-zero if the error is fatal or 0 otherwise. 116.Sh SEE ALSO 117.Xr ERR 3 , 118.Xr ERR_get_error 3 119.Sh HISTORY 120.Fn ERR_GET_LIB , 121.Fn ERR_GET_FUNC , 122.Fn ERR_GET_REASON , 123and 124.Fn ERR_FATAL_ERROR 125first appeared in SSLeay 0.4.4 and have been available since 126.Ox 2.4 . 127