<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Output a binary dump of cached files and user variables to a file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apc-bin-dump.html">apc_bin_dump</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apc-bin-load.html">apc_bin_load</a></div>
<div class="up"><a href="ref.apc.html">APC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.apc-bin-dumpfile" class="refentry">
<div class="refnamediv">
<h1 class="refname">apc_bin_dumpfile</h1>
<p class="verinfo">(PECL apc >= 3.1.4)</p><p class="refpurpose"><span class="refname">apc_bin_dumpfile</span> — <span class="dc-title">Output a binary dump of cached files and user variables to a file</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apc-bin-dumpfile-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>apc_bin_dumpfile</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$files</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$user_vars</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code><span class="initializer"> = NULL</span></span>
]] )</div>
<p class="para rdfs-comment">
Outputs a binary dump of the given files and user variables from the APC
cache to the named file.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apc-bin-dumpfile-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">files</code></em></span>
<dd>
<p class="para">
The file names being dumped.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">user_vars</code></em></span>
<dd>
<p class="para">
The user variables being dumped.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
The filename where the dump is being saved.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Flags passed to the <em><code class="parameter">filename</code></em> stream. See the
<span class="function"><a href="function.file-put-contents.html" class="function">file_put_contents()</a></span> documentation for details.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<p class="para">
The context passed to the <em><code class="parameter">filename</code></em> stream. See the
<span class="function"><a href="function.file-put-contents.html" class="function">file_put_contents()</a></span> documentation for details.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apc-bin-dumpfile-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The number of bytes written to the file, otherwise
<strong><code>FALSE</code></strong> if APC is not enabled, <em><code class="parameter">filename</code></em> is an invalid file name,
<em><code class="parameter">filename</code></em> 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.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.apc-bin-dumpfile-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.apc-bin-dump.html" class="function" rel="rdfs-seeAlso">apc_bin_dump()</a> - Get a binary dump of the given files and user variables</span></li>
<li class="member"> <span class="function"><a href="function.apc-bin-load.html" class="function" rel="rdfs-seeAlso">apc_bin_load()</a> - Load a binary dump into the APC file/user cache</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apc-bin-dump.html">apc_bin_dump</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apc-bin-load.html">apc_bin_load</a></div>
<div class="up"><a href="ref.apc.html">APC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
