xref: /freebsd/contrib/openpam/doc/man/pam_error.3 (revision 405c3050f102b8c74782f0366c8ead927bd07b68)
1.\" Generated from pam_error.c by gendoc.pl
2.\" $OpenPAM: pam_error.c 938 2017-04-30 21:34:42Z des $
3.Dd April 30, 2017
4.Dt PAM_ERROR 3
5.Os
6.Sh NAME
7.Nm pam_error
8.Nd display an error message
9.Sh SYNOPSIS
10.In sys/types.h
11.In security/pam_appl.h
12.Ft "int"
13.Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..."
14.Sh DESCRIPTION
15The
16.Fn pam_error
17function displays an error message through the
18intermediary of the given PAM context's conversation function.
19.Pp
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