freebsd man page for ipsec_strerror

IPSEC_STRERROR(3)					   BSD Library Functions Manual 					 IPSEC_STRERROR(3)

NAME
     ipsec_strerror -- error messages for the IPsec policy manipulation library

SYNOPSIS
     #include <netipsec/ipsec.h>

     const char *
     ipsec_strerror();

DESCRIPTION
     <netipsec/ipsec.h> declares

	   extern int ipsec_errcode;

     which is used to pass an error code from IPsec policy manipulation library to a user program.  The ipsec_strerror() function can be used to
     obtain the error message string for the error code.

     The array pointed to is not to be modified by the program.  Since ipsec_strerror() uses strerror(3) as an underlying function, calling
     strerror(3) after ipsec_strerror() would overwrite the return value from ipsec_strerror() and make it invalid.

RETURN VALUES
     The ipsec_strerror() function always returns a pointer to C string.  The C string must not be overwritten by the caller.

SEE ALSO
     ipsec_set_policy(3)

HISTORY
     The ipsec_strerror() function first appeared in WIDE/KAME IPv6 protocol stack kit.

BUGS
     The ipsec_strerror() function will return its result which may be overwritten by subsequent calls.

     ipsec_errcode is not thread safe.

BSD
								 February 14, 2006							       BSD