xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_strerror.3 (revision d909946ca08dceb44d7d0f22ec9488679695d976)
1.\"	$NetBSD: pam_strerror.3,v 1.7 2015/06/05 20:41:46 joerg 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 12, 2014
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 in the context of the PAM transaction described by the
25.Fa pamh .
26The
27.Fa pamh
28argument is ignored.
29For compatibility with other implementations, it should be either a
30valid PAM handle returned by a previous call to
31.Xr pam_start 3 ,
32or
33.Dv NULL .
34.Sh RETURN VALUES
35The
36.Fn pam_strerror
37function returns
38.Dv NULL
39on failure.
40.Sh SEE ALSO
41.Xr pam 3 ,
42.Xr pam_start 3
43.Sh STANDARDS
44.Rs
45.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
46.%D "June 1997"
47.Re
48.Sh AUTHORS
49The
50.Fn pam_strerror
51function and this manual page were
52developed for the
53.Fx
54Project by ThinkSec AS and Network Associates Laboratories, the
55Security Research Division of Network Associates, Inc.\& under
56DARPA/SPAWAR contract N66001-01-C-8035
57.Pq Dq CBOSS ,
58as part of the DARPA CHATS research program.
59.Pp
60The OpenPAM library is maintained by
61.An Dag-Erling Sm\(/orgrav Aq des@des.no .
62