xref: /freebsd/contrib/openpam/doc/man/pam_strerror.3 (revision bc96366c864c07ef352edb92017357917c75b36c)
1.\" Generated from pam_strerror.c by gendoc.pl
2.\" $Id: pam_strerror.c 648 2013-03-05 17:54:27Z des $
3.Dd September 12, 2014
4.Dt PAM_STRERROR 3
5.Os
6.Sh NAME
7.Nm pam_strerror
8.Nd get PAM standard error message string
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "const char *"
15.Fn pam_strerror "const pam_handle_t *pamh" "int error_number"
16.Sh DESCRIPTION
17The
18.Fn pam_strerror
19function returns a pointer to a string containing a
20textual description of the error indicated by the
21.Fa error_number
22argument.
23The
24.Fa pamh
25argument is ignored.
26For compatibility with other implementations, it should be either a
27valid PAM handle returned by a previous call to
28.Xr pam_start 3 ,
29or
30.Dv NULL .
31.Sh RETURN VALUES
32The
33.Fn pam_strerror
34function returns
35.Dv NULL
36on failure.
37.Sh SEE ALSO
38.Xr pam 3 ,
39.Xr pam_start 3
40.Sh STANDARDS
41.Rs
42.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
43.%D "June 1997"
44.Re
45.Sh AUTHORS
46The
47.Fn pam_strerror
48function and this manual page were
49developed for the
50.Fx
51Project by ThinkSec AS and Network Associates Laboratories, the
52Security Research Division of Network Associates, Inc.\& under
53DARPA/SPAWAR contract N66001-01-C-8035
54.Pq Dq CBOSS ,
55as part of the DARPA CHATS research program.
56.Pp
57The OpenPAM library is maintained by
58.An Dag-Erling Sm\(/orgrav Aq des@des.no .
59