php-doc-en/reference/apache/functions/apache-setenv.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.7 -->
  <refentry id="function.apache-setenv">
   <refnamediv>
    <refname>apache_setenv</refname>
    <refpurpose>Set an Apache subprocess_env variable</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>int</type><methodname>apache_setenv</methodname>
     <methodparam><type>string</type><parameter>variable</parameter></methodparam>
     <methodparam><type>string</type><parameter>value</parameter></methodparam>
     <methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
    </methodsynopsis>
    <para>
     <function>apache_setenv</function> sets the value of the Apache
     environment variable specified by
     <parameter>variable</parameter>.
    </para>
    <note>
     <para>
      When setting an Apache environment variable, the corresponding $_SERVER
      variable is not changed.
     </para>
    </note>
    <example>
     <title>Setting an Apache environment variable using <function>apache_setenv</function></title>
     <programlisting role="php">
<![CDATA[
<?php
apache_setenv("EXAMPLE_VAR", "Example Value");
?>
]]>
     </programlisting>
    </example>
    <para>
     <function>apache_setenv</function> can be paired up with
     <function>apache_getenv</function> across separate pages or for setting
     variables to pass to Server Side Includes (.shtml) that have been
     included in PHP scripts.
    </para>
    <para>
     See also <function>apache_getenv</function>.
    </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
-->