document the new optional parameter

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@171202 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2004-10-24 17:07:11 +00:00
parent d34c952697
commit a9cb3f53ad

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/datetime.xml, last change in rev 1.2 -->
<refentry id="function.gettimeofday">
<refnamediv>
@ -8,18 +8,27 @@
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>gettimeofday</methodname>
<void/>
</methodsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>gettimeofday</methodname>
<methodparam choice="opt"><type>bool</type><parameter>return_float</parameter></methodparam>
</methodsynopsis>
<para>
This is an interface to gettimeofday(2). It returns an
associative array containing the data returned from the system
call.
</para>
<para>
Since PHP 5.1.0 there is an optional parameter,
<parameter>return_float</parameter>, which makes
<function>gettimeofday</function> return a float when it is set to
&true;.
</para>
<para>
Array keys:
<itemizedlist>
<listitem>
<simpara>
"sec" - seconds
"sec" - seconds since the Unix Epoch
</simpara>
</listitem>
<listitem>
@ -48,6 +57,8 @@
<![CDATA[
<?php
print_r(gettimeofday());
echo gettimeofday(true);
?>
]]>
</programlisting>
@ -63,6 +74,8 @@ Array
[minuteswest] => 0
[dsttime] => 1
)
1073504408.23910
]]>
</screen>
</example>