granicus.if.org Git - linux-pam/blob - doc/man/pam_strerror.3

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\" ripped off from Rick Faith's getgroups man page
   3 .\" $Id$
   4 .\" Copyright (c) Andrew G. Morgan 1996-7 <morgan@linux.kernel.org>
   5 .TH PAM_STRERROR 3 "1999 Oct 4" "Linux-PAM 0.70" "Programmers' Manual"
   6 .SH NAME
   7
   8 pam_strerror \- return a textual description of a Linux-PAM error
   9
  10 .SH SYNOPSIS
  11 .B #include <security/pam_appl.h>
  12 .br
  13 or,
  14 .br
  15 .B #include <security/pam_modules.h>
  16 .sp
  17 .BI "const char * pam_strerror( pam_handle_t " "*pamh" ", int " pam_error ");"
  18 .sp 2
  19 .SH DESCRIPTION
  20 .B pam_strerror
  21
  22 This function returns some text describing the
  23 .BR Linux-PAM
  24 error associated with the
  25 .B pam_error
  26 argument.
  27
  28 .SH "RETURN VALUE"
  29
  30 On success this function returns a description of the indicated
  31 error.  Should the function not recognize the error, ``Unknown
  32 Linux-PAM error'' is returned.
  33
  34 .SH "CONFORMING TO"
  35 DCE-RFC 86.0, October 1995.
  36
  37 .SH BUGS
  38 .sp 2
  39 This function should be internationalized.
  40
  41 .SH "SEE ALSO"
  42
  43 .BR pam "(8). "
  44
  45 Also, see the three
  46 .BR Linux-PAM
  47 Guides, for
  48 .BR "System administrators" ", "
  49 .BR "module developers" ", "
  50 and
  51 .BR "application developers" ". "