xref: /freebsd/lib/libipsec/ipsec_strerror.3 (revision f894c43f1032a8b5730e940c4527873c45f5fa4c)
19a4365d0SYoshinobu Inoue.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
29a4365d0SYoshinobu Inoue.\" All rights reserved.
39a4365d0SYoshinobu Inoue.\"
49a4365d0SYoshinobu Inoue.\" Redistribution and use in source and binary forms, with or without
59a4365d0SYoshinobu Inoue.\" modification, are permitted provided that the following conditions
69a4365d0SYoshinobu Inoue.\" are met:
79a4365d0SYoshinobu Inoue.\" 1. Redistributions of source code must retain the above copyright
89a4365d0SYoshinobu Inoue.\"    notice, this list of conditions and the following disclaimer.
99a4365d0SYoshinobu Inoue.\" 2. Redistributions in binary form must reproduce the above copyright
109a4365d0SYoshinobu Inoue.\"    notice, this list of conditions and the following disclaimer in the
119a4365d0SYoshinobu Inoue.\"    documentation and/or other materials provided with the distribution.
129a4365d0SYoshinobu Inoue.\" 3. Neither the name of the project nor the names of its contributors
139a4365d0SYoshinobu Inoue.\"    may be used to endorse or promote products derived from this software
149a4365d0SYoshinobu Inoue.\"    without specific prior written permission.
159a4365d0SYoshinobu Inoue.\"
169a4365d0SYoshinobu Inoue.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
179a4365d0SYoshinobu Inoue.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
189a4365d0SYoshinobu Inoue.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
199a4365d0SYoshinobu Inoue.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
209a4365d0SYoshinobu Inoue.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
219a4365d0SYoshinobu Inoue.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
229a4365d0SYoshinobu Inoue.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
239a4365d0SYoshinobu Inoue.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
249a4365d0SYoshinobu Inoue.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
259a4365d0SYoshinobu Inoue.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
269a4365d0SYoshinobu Inoue.\" SUCH DAMAGE.
279a4365d0SYoshinobu Inoue.\"
289a4365d0SYoshinobu Inoue.\"     $Id: ipsec_strerror.3,v 1.2 1999/09/21 03:49:19 itojun Exp $
299a4365d0SYoshinobu Inoue.\"     $FreeBSD$
309a4365d0SYoshinobu Inoue.\"
319a4365d0SYoshinobu Inoue.Dd May 6, 1998
329a4365d0SYoshinobu Inoue.Dt IPSEC_STRERROR 3
33f894c43fSAlexey Zelkin.Os
349a4365d0SYoshinobu Inoue.Sh NAME
359a4365d0SYoshinobu Inoue.Nm ipsec_strerror
369a4365d0SYoshinobu Inoue.Nd error code for IPsec policy manipulation library
37f894c43fSAlexey Zelkin.Sh LIBRARY
38f894c43fSAlexey Zelkin.Lb libipsec
399a4365d0SYoshinobu Inoue.Sh SYNOPSIS
40e231122dSBruce Evans.Fd #include <sys/types.h>
419a4365d0SYoshinobu Inoue.Fd #include <netinet6/ipsec.h>
429a4365d0SYoshinobu Inoue.Ft "char *"
43e231122dSBruce Evans.Fn ipsec_strerror void
449a4365d0SYoshinobu Inoue.Sh DESCRIPTION
459a4365d0SYoshinobu Inoue.Pa netinet6/ipsec.h
469a4365d0SYoshinobu Inouedeclares
479a4365d0SYoshinobu Inoue.Pp
489a4365d0SYoshinobu Inoue.Dl extern int ipsec_errcode;
499a4365d0SYoshinobu Inoue.Pp
509a4365d0SYoshinobu Inouewhich is used to pass error code from IPsec policy manipulation library
519a4365d0SYoshinobu Inoueto user program.
529a4365d0SYoshinobu Inoue.Fn ipsec_strerror
539a4365d0SYoshinobu Inouecan be used to obtain error message string for the error code.
549a4365d0SYoshinobu Inoue.Sh RETURN VALUES
559a4365d0SYoshinobu Inoue.Fn ipsec_strerror
569a4365d0SYoshinobu Inouealways return a pointer to C string.
579a4365d0SYoshinobu InoueThe C string must not be overwritten by user programs.
589a4365d0SYoshinobu Inoue.\"
599a4365d0SYoshinobu Inoue.\" .Sh SEE ALSO
609a4365d0SYoshinobu Inoue.\"
619a4365d0SYoshinobu Inoue.Sh HISTORY
629a4365d0SYoshinobu InoueThe functions first appeared in WIDE/KAME IPv6 protocol stack kit.
63f894c43fSAlexey ZelkinIPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack
64f894c43fSAlexey Zelkinwas initialy integrated into
65f894c43fSAlexey Zelkin.Fx 4.0
66