doc/man/pam_misc_drop_env.3.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="pam_misc_drop_env">

  <refmeta>
    <refentrytitle>pam_misc_drop_env</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_misc_drop_env-name">
    <refname>pam_misc_drop_env</refname>
    <refpurpose>liberating a locally saved environment</refpurpose>
  </refnamediv>

<!-- body begins here -->

  <refsynopsisdiv>
    <funcsynopsis id="pam_misc_drop_env-synopsis">
      <funcsynopsisinfo>#include &lt;security/pam_misc.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>int <function>pam_misc_drop_env</function></funcdef>
        <paramdef>char **<parameter>env</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1 id='pam_misc_drop_env-description'>
    <title>DESCRIPTION</title>
    <para>
      This function is defined to complement the <citerefentry>
        <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> function. It liberates the memory associated
      with <parameter>env</parameter>, <emphasis>overwriting</emphasis>
      with <emphasis>0</emphasis> all memory before
      <function>free()</function>ing it.
    </para>
  </refsect1>

  <refsect1 id='pam_misc_drop_env-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 id='pam_misc_drop_env-standards'>
    <title>STANDARDS</title>
    <para>
      The <function>pam_misc_drop_env</function> function is part of the
      <command>libpam_misc</command> Library and not defined in any
      standard.
    </para>
  </refsect1>

</refentry>