Go to main content

man pages section 3: Extended Library Functions, Volume 3

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pam_getenv(3PAM)

Name

pam_getenv - returns the value for a PAM environment name

Synopsis

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

char *pam_getenv(pam_handle_t *pamh, const char *name);

Description

The pam_getenv() function searches the PAM handle pamh for a value associated with name. If a value is present, pam_getenv() makes a copy of the value and returns a pointer to the copy back to the calling application. If no such entry exists, pam_getenv() returns NULL. It is the responsibility of the calling application to free the memory returned by pam_getenv().

Return Values

If successful, pam_getenv() returns a copy of the value associated with name in the PAM handle; otherwise, it returns a NULL pointer.

Attributes

See attributes(7) for descriptions of the following attributes:

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

See Also

libpam(3LIB), pam(3PAM), pam_getenvlist(3PAM), pam_putenv(3PAM), attributes(7)

Notes

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