<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry id="function.apache-getenv">
 <refnamediv>
  <refname>apache_getenv</refname>
  <refpurpose>Get an Apache subprocess_env variable</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>apache_getenv</methodname>
   <methodparam><type>string</type><parameter>variable</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
  </methodsynopsis>
  <para>
   Get an Apache environment variable as specified by 
   <parameter>variable</parameter>.
  </para>
  <para>
   This function requires Apache 2 otherwise it's undefined.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>variable</parameter></term>
     <listitem>
      <para>
       The Apache environment variable
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>walk_to_top</parameter></term>
     <listitem>
      <para>
       Whether to get the top-level variable available to all Apache layers.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The value of the Apache environment variable on success, or &false; on
   failure
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>apache_getenv</function> example</title>
    <para>
     The example above shows how to retrieve the value of the Apache
     environment variable <varname>SERVER_ADDR</varname>.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$ret = apache_getenv("SERVER_ADDR");
echo $ret;
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
42.24.42.240
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>apache_sentenv</function></member>
    <member><function>getenv</function></member>
    <member><link linkend="language.variables.superglobals">Superglobals</link></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->