<!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 all remaining data on a file pointer</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fopen.html">fopen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fputcsv.html">fputcsv</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fpassthru" class="refentry">
<div class="refnamediv">
<h1 class="refname">fpassthru</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">fpassthru</span> — <span class="dc-title">Output all remaining data on a file pointer</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fpassthru-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>fpassthru</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
)</div>
<p class="para rdfs-comment">
Reads to EOF on the given file pointer from the current position and
writes the results to the output buffer.
</p>
<p class="para">
You may need to call <span class="function"><a href="function.rewind.html" class="function">rewind()</a></span> to reset the file
pointer to the beginning of the file if you have already written data
to the file.
</p>
<p class="para">
If you just want to dump the contents of a file to the output buffer,
without first modifying it or seeking to a particular offset, you may
want to use the <span class="function"><a href="function.readfile.html" class="function">readfile()</a></span>, which saves you
the <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span> call.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fpassthru-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">handle</code></em></span>
<dd>
<p class="para">The file pointer must be valid, and must point to
a file successfully opened by <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span> or
<span class="function"><a href="function.fsockopen.html" class="function">fsockopen()</a></span> (and not yet closed by
<span class="function"><a href="function.fclose.html" class="function">fclose()</a></span>).</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fpassthru-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If an error occurs, <span class="function"><strong>fpassthru()</strong></span> returns
<strong><code>FALSE</code></strong>. Otherwise, <span class="function"><strong>fpassthru()</strong></span> returns
the number of characters read from <em><code class="parameter">handle</code></em>
and passed through to the output.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.fpassthru-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2386">
<p><strong>Example #1 Using <span class="function"><strong>fpassthru()</strong></span> with binary files</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// open the file in a binary mode<br /></span><span style="color: #0000BB">$name </span><span style="color: #007700">= </span><span style="color: #DD0000">'./img/ok.png'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #DD0000">'rb'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// send the right headers<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Length: " </span><span style="color: #007700">. </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// dump the picture and stop the script<br /></span><span style="color: #0000BB">fpassthru</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br />exit;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.fpassthru-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
When using <span class="function"><strong>fpassthru()</strong></span> on a binary file on Windows
systems, you should make sure to open the file in binary mode by
appending a <em>b</em> to the mode used in the call to
<span class="function"><a href="function.fopen.html" class="function">fopen()</a></span>.
</p>
<p class="para">
You are encouraged to use the <em>b</em> flag when dealing
with binary files, even if your system does not require it, so that
your scripts will be more portable.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.fpassthru-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.readfile.html" class="function" rel="rdfs-seeAlso">readfile()</a> - Outputs a file</span></li>
<li class="member"> <span class="function"><a href="function.fopen.html" class="function" rel="rdfs-seeAlso">fopen()</a> - Opens file or URL</span></li>
<li class="member"> <span class="function"><a href="function.popen.html" class="function" rel="rdfs-seeAlso">popen()</a> - Opens process file pointer</span></li>
<li class="member"> <span class="function"><a href="function.fsockopen.html" class="function" rel="rdfs-seeAlso">fsockopen()</a> - Open Internet or Unix domain socket connection</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fopen.html">fopen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fputcsv.html">fputcsv</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
