xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_strerror.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_strerror.3,v 1.10 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_strerror.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_STRERROR 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_strerror
944269bb5Schristos.Nd get PAM standard error message string
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "const char *"
1444269bb5Schristos.Fn pam_strerror "const pam_handle_t *pamh" "int error_number"
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_strerror
1844269bb5Schristosfunction returns a pointer to a string containing a
1944269bb5Schristostextual description of the error indicated by the
2044269bb5Schristos.Fa error_number
21db24f154Sjoergargument in the context of the PAM transaction described by the
22db24f154Sjoerg.Fa pamh .
2344269bb5SchristosThe
2444269bb5Schristos.Fa pamh
2544269bb5Schristosargument is ignored.
2644269bb5SchristosFor compatibility with other implementations, it should be either a
2744269bb5Schristosvalid PAM handle returned by a previous call to
2844269bb5Schristos.Xr pam_start 3 ,
2944269bb5Schristosor
3044269bb5Schristos.Dv NULL .
3144269bb5Schristos.Sh RETURN VALUES
3244269bb5SchristosThe
33e1b25b17Schristos.Fn pam_strerror
3444269bb5Schristosfunction returns
3544269bb5Schristos.Dv NULL
3644269bb5Schristoson failure.
3744269bb5Schristos.Sh SEE ALSO
3844269bb5Schristos.Xr pam 3 ,
3944269bb5Schristos.Xr pam_start 3
4044269bb5Schristos.Sh STANDARDS
4144269bb5Schristos.Rs
4244269bb5Schristos.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
4344269bb5Schristos.%D "June 1997"
4444269bb5Schristos.Re
4544269bb5Schristos.Sh AUTHORS
4644269bb5SchristosThe
47e1b25b17Schristos.Fn pam_strerror
48e1b25b17Schristosfunction and this manual page were
49e1b25b17Schristosdeveloped for the
5044269bb5Schristos.Fx
51e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
5244269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
5344269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
5444269bb5Schristos.Pq Dq CBOSS ,
5544269bb5Schristosas part of the DARPA CHATS research program.
568fa0fefeSchristos.Pp
578fa0fefeSchristosThe OpenPAM library is maintained by
584cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
59