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