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