php-doc-en/reference/apc/functions/apc-bin-load.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

100 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.apc-bin-load" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>apc_bin_load</refname>
<refpurpose>Load a binary dump into the APC file/user cache</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apc_bin_load</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Loads the given binary dump into the APC file/user cache.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The binary dump being loaded, likely from
<function>apc_bin_dump</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Either <constant>APC_BIN_VERIFY_CRC32</constant>, <constant>APC_BIN_VERIFY_MD5</constant>,
or both.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the binary dump <parameter>data</parameter> was loaded
with success, otherwise &false; is returned. &false; is returned if APC
is not enabled, or if the <parameter>data</parameter> is not a valid APC
binary dump (e.g., unexpected size).
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>apc_bin_load</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$data = apc_bin_dump(NULL, NULL);
apc_bin_load($data, APC_BIN_VERIFY_MD5 | APC_BIN_VERIFY_CRC32);
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>apc_bin_dump</function></member>
<member><function>apc_bin_loadfile</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
-->