Current File : //usr/share/man/man3pam/pam_strerror.3pam

'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc.   All Rights Reserved.
.TH pam_strerror 3PAM "9 Jul 2003" "SunOS 5.11" "PAM Library Functions"
.SH NAME
pam_strerror \- get PAM error message string
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpam\fR [ \fIlibrary\fR... ]
#include <security/pam_appl.h>

\fBconst char *\fR\fBpam_strerror\fR(\fBpam_handle_t*\fR\fIpamh\fR, \fBint\fR \fIerrnum\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBpam_strerror()\fR function maps the \fBPAM\fR error number in \fIerrnum\fR to a \fBPAM\fR error message string, and returns a pointer to that string. The application should not free or modify the string returned.
.sp
.LP
The \fIpamh\fR argument is the  \fBPAM\fR handle obtained by a prior call to \fBpam_start()\fR. If \fBpam_start()\fR returns an error, a null \fBPAM\fR handle should be passed.
.SH ERRORS
.sp
.LP
The \fBpam_strerror()\fR function returns the string "Unknown error" if \fIerrnum\fR is out-of-range.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for description of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe with exceptions
.TE

.SH SEE ALSO
.sp
.LP
\fBpam\fR(3PAM), \fBpam_start\fR(3PAM), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The interfaces in  \fBlibpam\fR are MT-Safe only if each thread within the multithreaded application uses its own  \fBPAM\fR handle.