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