memory-get-peak-usage.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.memory-get-peak-usage" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>memory_get_peak_usage</refname>
  <refpurpose>Returns the peak of memory allocated by PHP</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>memory_get_peak_usage</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>real_usage</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns the peak of memory, in bytes, that's been allocated to your PHP
   script.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>real_usage</parameter></term>
     <listitem>
      <para>
       Set this to &true; to get the real size of memory allocated from
       system. If not set or &false; only the memory used by
       <literal>emalloc()</literal> is reported.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the memory peak in bytes.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.2.1</entry>
       <entry>
        Compiling with <link linkend="ini.memory-limit">--enable-memory-limit</link> 
        is no longer required for this function to exist.
       </entry>
      </row>
      <row>
       <entry>5.2.0</entry>
       <entry>
        <parameter>real_usage</parameter> was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>memory_get_usage</function></member>
    <member><link linkend="ini.memory-limit">memory_limit</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
-->