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

   1 .\"     Title: pam_strerror
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
   4 .\"      Date: 06/27/2006
   5 .\"    Manual: Linux\-PAM Manual
   6 .\"    Source: Linux\-PAM Manual
   7 .\"
   8 .TH "PAM_STRERROR" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 pam_strerror \- return string describing PAM error code
  15 .SH "SYNOPSIS"
  16 .sp
  17 .ft B
  18 .nf
  19 #include <security/pam_appl.h>
  20 .fi
  21 .ft
  22 .HP 25
  23 .BI "const char *pam_strerror(pam_handle_t\ *" "pamh" ", int\ " "errnum" ");"
  24 .SH "DESCRIPTION"
  25 .PP
  26 The
  27 \fBpam_strerror\fR
  28 function returns a pointer to a string describing the error code passed in the argument
  29 \fIerrnum\fR, possibly using the LC_MESSAGES part of the current locale to select the appropriate language. This string must not be modified by the application. No library function will modify this string.
  30 .SH "RETURN VALUES"
  31 .PP
  32 This function returns always a pointer to a string.
  33 .SH "SEE ALSO"
  34 .PP
  35
  36 \fBpam\fR(8)