granicus.if.org Git - linux-pam/blob - doc/man/pam_misc_drop_env.3.xml

   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
   5 <refentry id="pam_misc_drop_env">
   6
   7   <refmeta>
   8     <refentrytitle>pam_misc_drop_env</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_misc_drop_env-name">
  14     <refname>pam_misc_drop_env</refname>
  15     <refpurpose>liberating a locally saved environment</refpurpose>
  16   </refnamediv>
  17
  18 <!-- body begins here -->
  19
  20   <refsynopsisdiv>
  21     <funcsynopsis id="pam_misc_drop_env-synopsis">
  22       <funcsynopsisinfo>#include &lt;security/pam_misc.h&gt;</funcsynopsisinfo>
  23       <funcprototype>
  24         <funcdef>int <function>pam_misc_drop_env</function></funcdef>
  25         <paramdef>char **<parameter>env</parameter></paramdef>
  26       </funcprototype>
  27     </funcsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1 id='pam_misc_drop_env-description'>
  31     <title>DESCRIPTION</title>
  32     <para>
  33       This function is defined to complement the <citerefentry>
  34         <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum>
  35       </citerefentry> function. It liberates the memory associated
  36       with <parameter>env</parameter>, <emphasis>overwriting</emphasis>
  37       with <emphasis>0</emphasis> all memory before
  38       <function>free()</function>ing it.
  39     </para>
  40   </refsect1>
  41
  42   <refsect1 id='pam_misc_drop_env-see_also'>
  43     <title>SEE ALSO</title>
  44     <para>
  45       <citerefentry>
  46         <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum>
  47       </citerefentry>,
  48       <citerefentry>
  49         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
  50       </citerefentry>
  51     </para>
  52   </refsect1>
  53
  54   <refsect1 id='pam_misc_drop_env-standards'>
  55     <title>STANDARDS</title>
  56     <para>
  57       The <function>pam_misc_drop_env</function> function is part of the
  58       <command>libpam_misc</command> Library and not defined in any
  59       standard.
  60     </para>
  61   </refsect1>
  62
  63 </refentry>