NAME

pam_get_data - get module information

SYNOPSIS

#include <security/pam_appl.h>

int pam_get_data (
    pam_handle_t    *pamh,
    const char      *module_data_name,
    void           **data
);

DESCRIPTION

The pam_get_data() function is used by the PAM modules to retrieve module-specific information from the PAM handle, pamh, for the module_data_name supplied. The data argument is assigned the address of the requested data. This data should not be freed by the caller; it will be freed by the cleanup function that was specified in the call to pam_set_data() when the pam_end() function is called.

The arguments for pam_get_data() are:

pamh (in)

The PAM authentication handle, obtained from a previous call to pam_start(), from which the data are retrieved.

module_data_name (in)

The name identifying the module data to be retrieved. This should be unique across all services.

data (out)

The data retrieved from pamh for module_data_name supplied.

RETURN VALUE

One of the following PAM status codes shall be returned:

[PAM_SUCCESS]

Successful completion.

[PAM_NO_MODULE_DATA]

No module-specific data are present.

[PAM_SYSTEM_ERR]

System error.

[PAM_BUF_ERR]

Memory buffer error.

[??] Some characters or strings that appear in the printed document are not easily representable using HTML.