te
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
pam_strerror - get PAM error message string

cc [ flag... ] file... -lpam [ library... ]
#include <security/pam_appl.h>



const char *pam_strerror(pam_handle_t*pamh, int errnum);

The pam_strerror() function maps the PAM error number in errnum to a PAM error message string, and returns a pointer to that string. The application should not free or modify the string returned.

The pamh argument is the PAM handle obtained by a prior call to pam_start(). If pam_start() returns an error, a null PAM handle should be passed.

The pam_strerror() function returns the string "Unknown error" if errnum is out-of-range.

See attributes(5) for description of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Stable

MT-Level MT-Safe with exceptions

pam(3PAM), pam_start(3PAM), attributes(5)

The interfaces in libpam are MT-Safe only if each thread within the multithreaded application uses its own PAM handle.