1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4 <refentry id='pam_getenv'>
6 <refentrytitle>pam_getenv</refentrytitle>
7 <manvolnum>3</manvolnum>
8 <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
11 <refnamediv id="pam_getenv-name">
12 <refname>pam_getenv</refname>
13 <refpurpose>get a PAM environment variable</refpurpose>
16 <!-- body begins here -->
19 <funcsynopsis id='pam_getenv-synopsis'>
20 <funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo>
22 <funcdef>const char *<function>pam_getenv</function></funcdef>
23 <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
24 <paramdef>const char *<parameter>name</parameter></paramdef>
30 <refsect1 id='pam_getenv-description'>
31 <title>DESCRIPTION</title>
33 The <function>pam_getenv</function> function searches the
34 PAM environment list as associated with the handle
35 <emphasis>pamh</emphasis> for an item that matches the string
36 pointed to by <emphasis>name</emphasis> and returns a pointer
37 to the value of the environment variable. The application is
38 not allowed to free the data.
42 <refsect1 id="pam_getenv-return_values">
43 <title>RETURN VALUES</title>
45 The <function>pam_getenv</function> function returns NULL
50 <refsect1 id='pam_getenv-see_also'>
51 <title>SEE ALSO</title>
54 <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
57 <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum>
60 <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum>
63 <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>