xref: /freebsd/lib/libipsec/ipsec_strerror.3 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
1.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the project nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     $Id: ipsec_strerror.3,v 1.2 1999/09/21 03:49:19 itojun Exp $
29.\"     $FreeBSD$
30.\"
31.Dd May 6, 1998
32.Dt IPSEC_STRERROR 3
33.Os
34.Sh NAME
35.Nm ipsec_strerror
36.Nd error code for IPsec policy manipulation library
37.Sh LIBRARY
38.Lb libipsec
39.Sh SYNOPSIS
40.Fd #include <sys/types.h>
41.Fd #include <netinet6/ipsec.h>
42.Ft "char *"
43.Fn ipsec_strerror void
44.Sh DESCRIPTION
45.Pa netinet6/ipsec.h
46declares
47.Pp
48.Dl extern int ipsec_errcode;
49.Pp
50which is used to pass error code from IPsec policy manipulation library
51to user program.
52.Fn ipsec_strerror
53can be used to obtain error message string for the error code.
54.Sh RETURN VALUES
55.Fn ipsec_strerror
56always return a pointer to C string.
57The C string must not be overwritten by user programs.
58.\"
59.\" .Sh SEE ALSO
60.\"
61.Sh HISTORY
62The functions first appeared in WIDE/KAME IPv6 protocol stack kit.
63IPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack
64was initialy integrated into
65.Fx 4.0
66