contrib/openpam/doc/man/pam_strerror.3

   1 .\" Generated from pam_strerror.c by gendoc.pl
   2 .\" $Id: pam_strerror.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt PAM_STRERROR 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_strerror
   8 .Nd get PAM standard error message string
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .Ft "const char *"
  15 .Fn pam_strerror "const pam_handle_t *pamh" "int error_number"
  16 .Sh DESCRIPTION
  17 The
  18 .Fn pam_strerror
  19 function returns a pointer to a string containing a
  20 textual description of the error indicated by the
  21 .Fa error_number
  22 argument.
  23 The
  24 .Fa pamh
  25 argument is ignored.
  26 For compatibility with other implementations, it should be either a
  27 valid PAM handle returned by a previous call to
  28 .Xr pam_start 3 ,
  29 or
  30 .Dv NULL .
  31 .Sh RETURN VALUES
  32 The
  33 .Fn pam_strerror
  34 function returns
  35 .Dv NULL
  36 on failure.
  37 .Sh SEE ALSO
  38 .Xr pam 3 ,
  39 .Xr pam_start 3
  40 .Sh STANDARDS
  41 .Rs
  42 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  43 .%D "June 1997"
  44 .Re
  45 .Sh AUTHORS
  46 The
  47 .Fn pam_strerror
  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 des@des.no .