# pam_getenvlist - getting the PAM environment - man(3) - [phpMan]

[_PAM_GETENVLIST_(3)](https://www.chedong.com/phpMan.php/man/PAMGETENVLIST/3/markdown)                         Linux-PAM Manual                         [_PAM_GETENVLIST_(3)](https://www.chedong.com/phpMan.php/man/PAMGETENVLIST/3/markdown)

## NAME
       pam_getenvlist - getting the PAM environment

## SYNOPSIS
### #include <security/pam_appl.h>


       **char **pam_getenvlist(pam_handle_t *_**pamh_**);**

## DESCRIPTION
       The **pam_getenvlist **function returns a complete copy of the PAM environment as associated with
       the handle _pamh_. The PAM environment variables represent the contents of the regular
       environment variables of the authenticated user when service is granted.

       The format of the memory is a malloc()'d array of char pointers, the last element of which is
       set to NULL. Each of the non-NULL entries in this array point to a NUL terminated and
       malloc()'d char string of the form: "_name=value_".

       It should be noted that this memory will never be free()'d by libpam. Once obtained by a call
       to **pam_getenvlist**, it is the responsibility of the calling application to free() this memory.

       It is by design, and not a coincidence, that the format and contents of the returned array
       matches that required for the third argument of the [**execle**(3)](https://www.chedong.com/phpMan.php/man/execle/3/markdown) function call.

## RETURN VALUES
       The **pam_getenvlist **function returns NULL on failure.

## SEE ALSO
       [**pam_start**(3)](https://www.chedong.com/phpMan.php/man/pamstart/3/markdown), [**pam_getenv**(3)](https://www.chedong.com/phpMan.php/man/pamgetenv/3/markdown), [**pam_putenv**(3)](https://www.chedong.com/phpMan.php/man/pamputenv/3/markdown), [**pam**(7)](https://www.chedong.com/phpMan.php/man/pam/7/markdown)

Linux-PAM                                    05/07/2023                            [_PAM_GETENVLIST_(3)](https://www.chedong.com/phpMan.php/man/PAMGETENVLIST/3/markdown)
