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