Initial import of the CDE 2.1.30 sources from the Open Group.

cde/lib/pam/man/man3/pam_strerror.3

@@ -0,0 +1,60 @@
+.\" $XConsortium: pam_strerror.3 /main/5 1996/10/29 15:20:47 drk $
+.\" Sccs id goes here
+'\"macro stdmacro
+.\" Copyright (c) 1995, Sun Microsystems, Inc. 
+.\" All Rights Reserved
+.nr X
+.TH pam_strerror 3 "9 Jan 1996"
+.SH NAME
+pam_strerror \- get PAM error message string
+.SH SYNOPSIS
+.LP
+.B cc
+.RI "[ " "flag" " \|.\|.\|. ] " "file" " \|.\|.\|."
+.B \-lpam
+.RI "[ " "library" " \|.\|.\|. ]"
+.LP
+.nf
+.ft 3
+#include <security/pam_appl.h>
+.ft
+.fi
+.LP
+.BI "const char *pam_strerror(pam_handle_t" "*pamh" ,
+.BI "int " "errnum" );
+.SH DESCRIPTION
+.IX "string operation" "get PAM error message string" "" "get PAM error message string \(em \fLpam_strerror\fP"
+.IX "PAM error messages" "get string" "" "get string \(em \fLpam_strerror\fP"
+.B pam_strerror(\|) 
+maps the
+.SM PAM
+error number in
+.I errnum
+to a
+.SM PAM
+error message string, and returns a pointer to that string.
+The application should not free or modify the string returned.
+.LP
+The
+.I pamh
+arguement is the 
+.SM PAM
+handle obtained by a prior call to
+.BR pam_start(\|) .
+If
+.B pam_start(\|)
+returns an error, a
+.SB NULL
+.SM PAM
+handle should be passed.
+.SH ERRORS
+.LP
+.B pam_strerror(\|)
+returns
+.SB NULL
+if
+.I errnum
+is out-of-range.
+.SH "SEE ALSO"
+.BR pam (3),
+.BR pam_start (3)