contrib/openpam/doc/man/pam_strerror.3

   1 .\" Generated from pam_strerror.c by gendoc.pl
   2 .\" $OpenPAM: pam_strerror.c 938 2017-04-30 21:34:42Z des $
   3 .Dd February 24, 2019
   4 .Dt PAM_STRERROR 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_strerror
   8 .Nd get PAM standard error message string
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "const char *"
  13 .Fn pam_strerror "const pam_handle_t *pamh" "int error_number"
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_strerror
  17 function returns a pointer to a string containing a
  18 textual description of the error indicated by the
  19 .Fa error_number
  20 argument.
  21 The
  22 .Fa pamh
  23 argument is ignored.
  24 For compatibility with other implementations, it should be either a
  25 valid PAM handle returned by a previous call to
  26 .Xr pam_start 3 ,
  27 or
  28 .Dv NULL .
  29 .Sh RETURN VALUES
  30 The
  31 .Fn pam_strerror
  32 function returns
  33 .Dv NULL
  34 on failure.
  35 .Sh SEE ALSO
  36 .Xr pam 3 ,
  37 .Xr pam_start 3
  38 .Sh STANDARDS
  39 .Rs
  40 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  41 .%D "June 1997"
  42 .Re
  43 .Sh AUTHORS
  44 The
  45 .Fn pam_strerror
  46 function and this manual page were
  47 developed for the
  48 .Fx
  49 Project by ThinkSec AS and Network Associates Laboratories, the
  50 Security Research Division of Network Associates, Inc.\& under
  51 DARPA/SPAWAR contract N66001-01-C-8035
  52 .Pq Dq CBOSS ,
  53 as part of the DARPA CHATS research program.
  54 .Pp
  55 The OpenPAM library is maintained by
  56 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .