xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_strerror.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1.\"	$NetBSD: pam_strerror.3,v 1.10 2023/06/30 21:46:20 christos Exp $
2.\"
3.\" Generated from pam_strerror.c by gendoc.pl
4.Dd June 27, 2023
5.Dt PAM_STRERROR 3
6.Os
7.Sh NAME
8.Nm pam_strerror
9.Nd get PAM standard error message string
10.Sh SYNOPSIS
11.In sys/types.h
12.In security/pam_appl.h
13.Ft "const char *"
14.Fn pam_strerror "const pam_handle_t *pamh" "int error_number"
15.Sh DESCRIPTION
16The
17.Fn pam_strerror
18function returns a pointer to a string containing a
19textual description of the error indicated by the
20.Fa error_number
21argument in the context of the PAM transaction described by the
22.Fa pamh .
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 Mt des@des.no .
59