pam_strerror(3PAM)

Name

pam_strerror - get PAM error message string

Synopsis

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

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

Description

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.

Errors

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

Attributes

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

ATTRIBUTE TYPE ATTRIBUTE VALUE Interface Stability Committed MT-Level MT-Safe with exceptions

See also

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

Notes

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