xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_error.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1.\"	$NetBSD: pam_error.3,v 1.9 2023/06/30 21:46:20 christos Exp $
2.\"
3.\" Generated from pam_error.c by gendoc.pl
4.Dd June 27, 2023
5.Dt PAM_ERROR 3
6.Os
7.Sh NAME
8.Nm pam_error
9.Nd display an error message
10.Sh SYNOPSIS
11.In sys/types.h
12.In security/pam_appl.h
13.Ft "int"
14.Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..."
15.Sh DESCRIPTION
16The
17.Fn pam_error
18function displays an error message through the
19intermediary of the given PAM context's conversation function.
20.Sh RETURN VALUES
21The
22.Fn pam_error
23function returns one of the following values:
24.Bl -tag -width 18n
25.It Bq Er PAM_SUCCESS
26Success.
27.It Bq Er PAM_BUF_ERR
28Memory buffer error.
29.It Bq Er PAM_CONV_ERR
30Conversation failure.
31.It Bq Er PAM_SYSTEM_ERR
32System error.
33.El
34.Sh SEE ALSO
35.Xr pam 3 ,
36.Xr pam_info 3 ,
37.Xr pam_prompt 3 ,
38.Xr pam_strerror 3 ,
39.Xr pam_verror 3
40.Sh STANDARDS
41The
42.Fn pam_error
43function is an OpenPAM extension.
44.Sh AUTHORS
45The
46.Fn pam_error
47function and this manual page were
48developed for the
49.Fx
50Project by ThinkSec AS and Network Associates Laboratories, the
51Security Research Division of Network Associates, Inc.\& under
52DARPA/SPAWAR contract N66001-01-C-8035
53.Pq Dq CBOSS ,
54as part of the DARPA CHATS research program.
55.Pp
56The OpenPAM library is maintained by
57.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
58