xref: /freebsd/contrib/openpam/doc/man/pam_error.3 (revision 076ad2f836d5f49dc1375f1677335a48fe0d4b82)
1.\" Generated from pam_error.c by gendoc.pl
2.\" $Id: pam_error.c 648 2013-03-05 17:54:27Z des $
3.Dd February 19, 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_BUF_ERR
26Memory buffer error.
27.It Bq Er PAM_CONV_ERR
28Conversation failure.
29.It Bq Er PAM_SYSTEM_ERR
30System error.
31.El
32.Sh SEE ALSO
33.Xr pam 3 ,
34.Xr pam_info 3 ,
35.Xr pam_prompt 3 ,
36.Xr pam_strerror 3 ,
37.Xr pam_verror 3
38.Sh STANDARDS
39The
40.Fn pam_error
41function is an OpenPAM extension.
42.Sh AUTHORS
43The
44.Fn pam_error
45function and this manual page were
46developed for the
47.Fx
48Project by ThinkSec AS and Network Associates Laboratories, the
49Security Research Division of Network Associates, Inc.\& under
50DARPA/SPAWAR contract N66001-01-C-8035
51.Pq Dq CBOSS ,
52as part of the DARPA CHATS research program.
53.Pp
54The OpenPAM library is maintained by
55.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
56