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.Dd February 14, 2006 31.Dt IPSEC_STRERROR 3 32.Os 33.\" 34.Sh NAME 35.Nm ipsec_strerror 36.Nd error messages for the IPsec policy manipulation library 37.\" 38.Sh SYNOPSIS 39.In netipsec/ipsec.h 40.Ft "const char *" 41.Fn ipsec_strerror 42.\" 43.Sh DESCRIPTION 44.In netipsec/ipsec.h 45declares 46.Pp 47.Dl extern int ipsec_errcode; 48.Pp 49which is used to pass an error code from IPsec policy manipulation library 50to a user program. 51The 52.Fn ipsec_strerror 53function can be used to obtain the error message string for the error code. 54.Pp 55The array pointed to is not to be modified by the program. 56Since 57.Fn ipsec_strerror 58uses 59.Xr strerror 3 60as an underlying function, calling 61.Xr strerror 3 62after 63.Fn ipsec_strerror 64would overwrite the return value from 65.Fn ipsec_strerror 66and make it invalid. 67.\" 68.Sh RETURN VALUES 69The 70.Fn ipsec_strerror 71function always returns a pointer to C string. 72The C string must not be overwritten by the caller. 73.\" 74.Sh SEE ALSO 75.Xr ipsec_set_policy 3 76.\" 77.Sh HISTORY 78The 79.Fn ipsec_strerror 80function first appeared in WIDE/KAME IPv6 protocol stack kit. 81.\" 82.Sh BUGS 83The 84.Fn ipsec_strerror 85function will return its result which may be overwritten by subsequent calls. 86.Pp 87.Va ipsec_errcode 88is not thread safe. 89