70 lines
2.5 KiB
Groff
70 lines
2.5 KiB
Groff
.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the project nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $NetBSD: ipsec_strerror.3,v 1.5 1999/12/21 14:17:18 itojun Exp $
|
|
.\" KAME Id: ipsec_strerror.3,v 1.1.2.1 1999/05/06 09:26:43 itojun Exp
|
|
.\"
|
|
.Dd May 6, 1998
|
|
.Dt IPSEC_STRERROR 3
|
|
.Os
|
|
.\"
|
|
.Sh NAME
|
|
.Nm ipsec_strerror
|
|
.Nd error code for IPsec policy manipulation library
|
|
.\"
|
|
.Sh LIBRARY
|
|
.Lb libipsec
|
|
.\"
|
|
.Sh SYNOPSIS
|
|
.Fd #include <netinet6/ipsec.h>
|
|
.Ft "char *"
|
|
.Fn ipsec_strerror "int code"
|
|
.\"
|
|
.Sh DESCRIPTION
|
|
.Pa netinet6/ipsec.h
|
|
declares
|
|
.Pp
|
|
.Dl extern int ipsec_errcode;
|
|
.Pp
|
|
which is used to pass error code from IPsec policy manipulation library
|
|
to user program.
|
|
.Fn ipsec_strerror
|
|
can be used to obtain error message string for the error code.
|
|
.\"
|
|
.Sh RETURN VALUES
|
|
.Fn ipsec_strerror
|
|
always return a pointer to C string.
|
|
The C string must not be overwritten by user programs.
|
|
.\"
|
|
.\" .Sh SEE ALSO
|
|
.\"
|
|
.Sh HISTORY
|
|
The functions first appeared in WIDE/KAME IPv6 protocol stack kit.
|
|
.\"
|
|
.\" .Sh BUGS
|
|
.\" (to be written)
|