xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_strerror.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: pam_strerror.3,v 1.9 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from pam_strerror.c by gendoc.pl
4.\" $OpenPAM: pam_strerror.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
6.Dt PAM_STRERROR 3
7.Os
8.Sh NAME
9.Nm pam_strerror
10.Nd get PAM standard error message string
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 in the context of the PAM transaction described by the
23.Fa pamh .
24The
25.Fa pamh
26argument is ignored.
27For compatibility with other implementations, it should be either a
28valid PAM handle returned by a previous call to
29.Xr pam_start 3 ,
30or
31.Dv NULL .
32.Sh RETURN VALUES
33The
34.Fn pam_strerror
35function returns
36.Dv NULL
37on failure.
38.Sh SEE ALSO
39.Xr pam 3 ,
40.Xr pam_start 3
41.Sh STANDARDS
42.Rs
43.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
44.%D "June 1997"
45.Re
46.Sh AUTHORS
47The
48.Fn pam_strerror
49function and this manual page were
50developed for the
51.Fx
52Project by ThinkSec AS and Network Associates Laboratories, the
53Security Research Division of Network Associates, Inc.\& under
54DARPA/SPAWAR contract N66001-01-C-8035
55.Pq Dq CBOSS ,
56as part of the DARPA CHATS research program.
57.Pp
58The OpenPAM library is maintained by
59.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
60