.\" Generated from pam_error.c by gendoc.pl
.\" $OpenPAM: pam_error.c 938 2017-04-30 21:34:42Z des $
.Dd April 30, 2017
.Dt PAM_ERROR 3
.Os
.Sh NAME
.Nm pam_error
.Nd display an error message
.Sh SYNOPSIS
.In sys/types.h
.In security/pam_appl.h
.In security/openpam.h
.Ft "int"
.Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..."
.Sh DESCRIPTION
The
.Fn pam_error
function displays an error message through the
intermediary of the given PAM context's conversation function.
.Pp
.Sh RETURN VALUES
The
.Fn pam_error
function returns one of the following values:
.Bl -tag -width 18n
.It Bq Er PAM_SUCCESS
Success.
.It Bq Er PAM_BUF_ERR
Memory buffer error.
.It Bq Er PAM_CONV_ERR
Conversation failure.
.It Bq Er PAM_SYSTEM_ERR
System error.
.El
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_info 3 ,
.Xr pam_prompt 3 ,
.Xr pam_strerror 3 ,
.Xr pam_verror 3
.Sh STANDARDS
The
.Fn pam_error
function is an OpenPAM extension.
.Sh AUTHORS
The
.Fn pam_error
function and this manual page were
developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc.\& under
DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
.Pp
The OpenPAM library is maintained by
.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .