This manual page is for Mac OS X version 10.6

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



PAM_GETENVLIST(3)                       BSD Library Functions Manual                       PAM_GETENVLIST(3)

NAME
     pam_getenvlist -- returns a list of all the PAM environment variables

LIBRARY
     Pluggable Authentication Module Library (libpam, -lpam)

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

     char **
     pam_getenvlist(pam_handle_t *pamh);

DESCRIPTION
     The pam_getenvlist function returns a copy of the given PAM context's environment list as a pointer to
     an array of strings.  The last element in the array is NULL.  The pointer is suitable for assignment to
     environ.

     The array and the strings it lists are allocated using malloc(3), and should be released using free(3)
     after use:

         char **envlist, **env;

         envlist = environ;
         environ = pam_getenvlist(pamh);
         /* do something nifty */
         for (env = environ; *env != NULL; env++)
             free(*env);
         free(environ);
         environ = envlist;

RETURN VALUES
     The pam_getenvlist function returns NULL on failure.

SEE ALSO
     free(3), malloc(3), pam(3), pam_getenv(3), pam_putenv(3), pam_setenv(3), environ(7)

STANDARDS
     X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules, June 1997.

AUTHORS
     The pam_getenvlist function and this manual page were developed for the FreeBSD Project by ThinkSec AS
     and Network Associates Laboratories, the Security Research Division of Network Associates, Inc. under
     DARPA/SPAWAR contract N66001-01-C-8035 (``CBOSS''), as part of the DARPA CHATS research program.

BSD                                           December 21, 2007                                          BSD

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.