userapps/opensource/ipsec-tools/src/libipsec/ipsec_strerror.3

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