pam_get_item

Name

pam_get_item -- obtain the value of the indicated item.

Synopsis

#include <security/pam_appl.h>

int pam_get_item(const pam_handle_t * pamh, int item_type, const void * * item);

Description

pam_get_item() obtains the value of the indicated item_type. The possible values of item_type are the same as listed for pam_set_item().

On success, item contains a pointer to the value of the corresponding item. Note that this is a pointer to the actual data and should not be free()'d or over-written.

Return Value

PAM_SUCCESS 

Success.

PAM_PERM_DENIED 

Application passed a NULL pointer for item.

PAM_BAD_ITEM 

Application attempted to get an undefined item.

Note: Errors may be translated to text with pam_strerror().