.\" Hey Emacs! This file is -*- nroff -*- source.
.\" ripped off from Rick Faith's getgroups man page
.\" $Id: pam_strerror.3,v 1.2 1997/02/15 18:53:04 morgan Exp $
.\" Copyright (c) Andrew G. Morgan 1996-7 <morgan@parc.power.net>
.TH PAM_STRERROR 3 "1997 Feb 15" "PAM 0.56" "Programmers' Manual"
.SH NAME

pam_strerror \- return a textual description of a PAM error

.SH SYNOPSIS
.B #include <security/pam_appl.h>
.br
or,
.br
.B #include <security/pam_modules.h>
.sp
.BI "const char *pam_strerror(" int " pam_error);
.sp 2
.SH DESCRIPTION
.B pam_strerror

This function returns a pointer to a line of text describing the
.BR PAM
error passed as its sole argument.

.SH "RETURN VALUE"

On success this function returns a description of the indicated
error.  Should the function not recognize the error, ``Unknown
PAM error'' is returned.

.SH "CONFORMING TO"
DCE-RFC 86.0, October 1995.

.SH BUGS
.sp 2
This function should be internationalized.

.SH "SEE ALSO"

.BR pam "(8). "

Also, see the three
.BR Linux-PAM
Guides, for
.BR "System administrators" ", "
.BR "module developers" ", "
and
.BR "application developers" ". "