1.\" $KAME: ipsec_strerror.3,v 1.9 2001/08/17 07:21:36 itojun Exp $ 2.\" 3.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the project nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" $FreeBSD$ 31.\" 32.Dd February 14, 2006 33.Dt IPSEC_STRERROR 3 34.Os 35.\" 36.Sh NAME 37.Nm ipsec_strerror 38.Nd error messages for the IPsec policy manipulation library 39.\" 40.Sh SYNOPSIS 41.In netipsec/ipsec.h 42.Ft "const char *" 43.Fn ipsec_strerror 44.\" 45.Sh DESCRIPTION 46.In netipsec/ipsec.h 47declares 48.Pp 49.Dl extern int ipsec_errcode; 50.Pp 51which is used to pass an error code from IPsec policy manipulation library 52to a user program. 53The 54.Fn ipsec_strerror 55function can be used to obtain the error message string for the error code. 56.Pp 57The array pointed to is not to be modified by the program. 58Since 59.Fn ipsec_strerror 60uses 61.Xr strerror 3 62as an underlying function, calling 63.Xr strerror 3 64after 65.Fn ipsec_strerror 66would overwrite the return value from 67.Fn ipsec_strerror 68and make it invalid. 69.\" 70.Sh RETURN VALUES 71The 72.Fn ipsec_strerror 73function always returns a pointer to C string. 74The C string must not be overwritten by the caller. 75.\" 76.Sh SEE ALSO 77.Xr ipsec_set_policy 3 78.\" 79.Sh HISTORY 80The 81.Fn ipsec_strerror 82function first appeared in WIDE/KAME IPv6 protocol stack kit. 83.\" 84.Sh BUGS 85The 86.Fn ipsec_strerror 87function will return its result which may be overwritten by subsequent calls. 88.Pp 89.Va ipsec_errcode 90is not thread safe. 91