php-doc-en/reference/info/functions/ini-set.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

116 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ini-set" xmlns="http://docbook.org/ns/docbook">
<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="examples">
&reftitle.examples;
<para>
<example>
<title>Setting an ini option</title>
<programlisting role="php">
<![CDATA[
<?php
echo ini_get('display_errors');
if (!ini_get('display_errors')) {
ini_set('display_errors', 1);
}
echo ini_get('display_errors');
?>
]]>
</programlisting>
</example>
</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:"~/.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
-->