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