php-doc-en/reference/info/functions/ini-set.xml
Mehdi Achour 7ec2efbee8 ref.info: switch to new style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228997 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-04 22:46:34 +00:00

94 lines
2.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.48 $ -->
<refentry id="function.ini-set">
<refnamediv>
<refname>ini_set</refname>
<refpurpose>Sets the value of a configuration option</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ini_set</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
<methodparam><type>string</type><parameter>newvalue</parameter></methodparam>
</methodsynopsis>
<para>
Sets the value of the given configuration option. The configuration option
will keep this new value during the script's execution, and will be restored
at the script's ending.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>varname</parameter></term>
<listitem>
<para>
</para>
<para>
Not all the available options can be changed using
<function>ini_set</function>. There is a list of all available options
in the <link linkend="ini.list">appendix</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newvalue</parameter></term>
<listitem>
<para>
The new value for the option.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the old value on success, &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>get_cfg_var</function></member>
<member><function>ini_get</function></member>
<member><function>ini_get_all</function></member>
<member><function>ini_restore</function></member>
<member>
<link linkend="configuration.changes">How to change configuration settings</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
-->