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