usr/src/man/man3pam/pam_strerror.3pam

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc.   All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PAM_STRERROR 3PAM "Jul 9, 2003"
   7 .SH NAME
   8 pam_strerror \- get PAM error message string
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpam\fR [ \fIlibrary\fR... ]
  13 #include <security/pam_appl.h>
  14
  15
  16
  17 \fBconst char *\fR\fBpam_strerror\fR(\fBpam_handle_t*\fR\fIpamh\fR, \fBint\fR \fIerrnum\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBpam_strerror()\fR function maps the \fBPAM\fR error number in
  24 \fIerrnum\fR to a \fBPAM\fR error message string, and returns a pointer to that
  25 string. The application should not free or modify the string returned.
  26 .sp
  27 .LP
  28 The \fIpamh\fR argument is the  \fBPAM\fR handle obtained by a prior call to
  29 \fBpam_start()\fR. If \fBpam_start()\fR returns an error, a null \fBPAM\fR
  30 handle should be passed.
  31 .SH ERRORS
  32 .sp
  33 .LP
  34 The \fBpam_strerror()\fR function returns the string "Unknown error" if
  35 \fIerrnum\fR is out-of-range.
  36 .SH ATTRIBUTES
  37 .sp
  38 .LP
  39 See \fBattributes\fR(5) for description of the following attributes:
  40 .sp
  41
  42 .sp
  43 .TS
  44 box;
  45 c | c
  46 l | l .
  47 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  48 _
  49 Interface Stability      Stable
  50 _
  51 MT-Level        MT-Safe with exceptions
  52 .TE
  53
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBpam\fR(3PAM), \fBpam_start\fR(3PAM), \fBattributes\fR(5)
  58 .SH NOTES
  59 .sp
  60 .LP
  61 The interfaces in  \fBlibpam\fR are MT-Safe only if each thread within the
  62 multithreaded application uses its own  \fBPAM\fR handle.