contrib/openpam/doc/man/pam_error.3

   1 .\" Generated from pam_error.c by gendoc.pl
   2 .\" $OpenPAM: pam_error.c 938 2017-04-30 21:34:42Z des $
   3 .Dd February 24, 2019
   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 .In security/openpam.h
  13 .Ft "int"
  14 .Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..."
  15 .Sh DESCRIPTION
  16 The
  17 .Fn pam_error
  18 function displays an error message through the
  19 intermediary of the given PAM context's conversation function.
  20 .Pp
  21 .Sh RETURN VALUES
  22 The
  23 .Fn pam_error
  24 function returns one of the following values:
  25 .Bl -tag -width 18n
  26 .It Bq Er PAM_SUCCESS
  27 Success.
  28 .It Bq Er PAM_BUF_ERR
  29 Memory buffer error.
  30 .It Bq Er PAM_CONV_ERR
  31 Conversation failure.
  32 .It Bq Er PAM_SYSTEM_ERR
  33 System 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
  42 The
  43 .Fn pam_error
  44 function is an OpenPAM extension.
  45 .Sh AUTHORS
  46 The
  47 .Fn pam_error
  48 function and this manual page were
  49 developed for the
  50 .Fx
  51 Project by ThinkSec AS and Network Associates Laboratories, the
  52 Security Research Division of Network Associates, Inc.\& under
  53 DARPA/SPAWAR contract N66001-01-C-8035
  54 .Pq Dq CBOSS ,
  55 as part of the DARPA CHATS research program.
  56 .Pp
  57 The OpenPAM library is maintained by
  58 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .