<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.apc-bin-dump" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>apc_bin_dump</refname>
  <refpurpose>Get a binary dump of the given files and user variables</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>apc_bin_dump</methodname>
   <methodparam choice="opt"><type>array</type><parameter>files</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>user_vars</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a binary dump of the given files and user variables from the APC cache.
   A &null; for files or user_vars signals a dump of every entry, whereas array() will dump
   nothing.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>files</parameter></term>
    <listitem>
     <para>
      The files. Passing in &null; signals a dump of every entry, while
      passing in <function>array</function> will dump nothing.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>user_vars</parameter></term>
    <listitem>
     <para>
      The user vars. Passing in &null; signals a dump of every entry, while
      passing in <function>array</function> will dump nothing.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a binary dump of the given files and user variables from the APC cache,
   &false; if APC is not enabled, or &null; if an unknown error is encountered.
  </para>
 </refsect1>

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