mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-17 09:28:56 +00:00
dec1f8445a
Sorry, translators, for breaking your builds again. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350871 c90b9560-bf6c-de11-be94-00142212c4b1
101 lines
3 KiB
XML
101 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.set-time-limit" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>set_time_limit</refname>
|
|
<refpurpose>Limits the maximum execution time</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>set_time_limit</methodname>
|
|
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Set the number of seconds a script is allowed to run. If this is reached,
|
|
the script returns a fatal error. The default limit is 30 seconds or, if
|
|
it exists, the <literal>max_execution_time</literal> value defined in the
|
|
&php.ini;.
|
|
</para>
|
|
<para>
|
|
When called, <function>set_time_limit</function> restarts the timeout
|
|
counter from zero. In other words, if the timeout is the default 30
|
|
seconds, and 25 seconds into script execution a call such as
|
|
<literal>set_time_limit(20)</literal> is made, the script will run for a
|
|
total of 45 seconds before timing out.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>seconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum execution time, in seconds. If set to zero, no time limit
|
|
is imposed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; on success, or &false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
The <function>set_time_limit</function> function and the configuration
|
|
directive <link linkend="ini.max-execution-time">max_execution_time</link>
|
|
only affect the execution time of the script itself. Any time spent on
|
|
activity that happens outside the execution of the script such as system
|
|
calls using <function>system</function>, stream operations, database
|
|
queries, etc. is not included when determining the maximum time that the
|
|
script has been running.
|
|
This is not true on Windows where the measured time is real.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><link linkend="ini.max-execution-time">max_execution_time</link></member>
|
|
<member><link linkend="ini.max-input-time">max_input_time</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
|
|
-->
|