get-cfg-var.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.get-cfg-var" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_cfg_var</refname>
  <refpurpose>Gets the value of a PHP configuration option</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>array</type><type>false</type></type><methodname>get_cfg_var</methodname>
   <methodparam><type>string</type><parameter>option</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets the value of a PHP configuration <parameter>option</parameter>.
  </para>
  <para>
   This function will not return configuration information set when the PHP
   was compiled, or read from an Apache configuration file.
  </para>
  <para>
   To check whether the system is using a <link
   linkend="configuration.file">configuration file</link>, try retrieving the
   value of the cfg_file_path configuration setting. If this is available, a
   configuration file is being used.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       The configuration option name.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the current value of the PHP configuration variable specified by
   <parameter>option</parameter>, or &false; if an error occurs.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ini_get</function></member>
    <member><function>ini_get_all</function></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:"~/.phpdoc/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
-->