memory-get-usage.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.memory-get-usage" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>memory_get_usage</refname>
  <refpurpose>Returns the amount of memory consumed by PHP script or allocated by system to PHP process</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>memory_get_usage</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>real_usage</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns the amount of memory, in bytes, that the PHP script is
   currently using.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>real_usage</parameter></term>
     <listitem>
      <para>
       Set this to &true; to get total memory allocated from
       the system to the PHP process, including unused memory pages.
       If not set or &false; only the memory used by PHP script is reported.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <note>
   <para>
    PHP tracks only memory that is allocated by the internal function <literal>emalloc()</literal>.
   </para>
  </note>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>memory_get_usage</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

// This is only an example, the numbers below will
// differ depending on the specific system

echo memory_get_usage(), "\n"; // 36640

$a = str_repeat("Hello", 4242);

echo memory_get_usage(), "\n"; // 57960

unset($a);

echo memory_get_usage(), "\n"; // 36744

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>memory_get_peak_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
-->