<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gettimeofday" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gettimeofday</refname>
  <refpurpose>Get current time</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>float</type></type><methodname>gettimeofday</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>as_float</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   This is an interface to gettimeofday(2). It returns an
   associative array containing the data returned from the system
   call.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>as_float</parameter></term>
     <listitem>
      <para>
       When set to &true;, a float instead of an array is returned.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   By default an <type>array</type> is returned. If <parameter>as_float</parameter>
   is set, then a <type>float</type> is returned.
  </para>
  <para>
   Array keys:
   <itemizedlist>
    <listitem>
     <simpara>
      "sec" - seconds since the Unix Epoch
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "usec" - microseconds
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "minuteswest" - minutes west of Greenwich
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "dsttime" - type of dst correction
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gettimeofday</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(gettimeofday());

echo gettimeofday(true);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [sec] => 1073504408
    [usec] => 238215
    [minuteswest] => 0
    [dsttime] => 1
)

1073504408.23910
]]>
    </screen>
   </example>
  </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
-->
