php-doc-en/reference/apc/functions/apc-bin-dumpfile.xml
Jakub Vrana a1ada2741d Fix protos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308219 c90b9560-bf6c-de11-be94-00142212c4b1
2011-02-10 19:59:01 +00:00

113 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.apc-bin-dumpfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>apc_bin_dumpfile</refname>
<refpurpose>Output a binary dump of cached files and user variables to a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>apc_bin_dumpfile</methodname>
<methodparam><type>array</type><parameter>files</parameter></methodparam>
<methodparam><type>array</type><parameter>user_vars</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Outputs a binary dump of the given files and user variables from the APC
cache to the named file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>files</parameter></term>
<listitem>
<para>
The file names being dumped.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_vars</parameter></term>
<listitem>
<para>
The user variables being dumped.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The filename where the dump is being saved.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Flags passed to the <parameter>filename</parameter> stream. See the
<function>file_put_contents</function> documentation for details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
The context passed to the <parameter>filename</parameter> stream. See the
<function>file_put_contents</function> documentation for details.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of bytes written to the file, otherwise
&false; if APC is not enabled, <parameter>filename</parameter> is an invalid file name,
<parameter>filename</parameter> can't be opened, the file dump can't be completed
(e.g., the hard drive is out of disk space), or an unknown error was encountered.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>apc_bin_dump</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
-->