<!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>Binary safe bzip2 file read</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bzopen.html">bzopen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bzwrite.html">bzwrite</a></div>
<div class="up"><a href="ref.bzip2.html">Bzip2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.bzread" class="refentry">
<div class="refnamediv">
<h1 class="refname">bzread</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">bzread</span> — <span class="dc-title">Binary safe bzip2 file read</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bzread-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>bzread</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bz</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code><span class="initializer"> = 1024</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>bzread()</strong></span> reads from the given bzip2 file pointer.
</p>
<p class="para">
Reading stops when <em><code class="parameter">length</code></em> (uncompressed) bytes have
been read or EOF is reached, whichever comes first.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bzread-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">bz</code></em></span>
<dd>
<p class="para">
The file pointer. It must be valid and must point to a file
successfully opened by <span class="function"><a href="function.bzopen.html" class="function">bzopen()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">length</code></em></span>
<dd>
<p class="para">
If not specified, <span class="function"><strong>bzread()</strong></span> will read 1024
(uncompressed) bytes at a time. A maximum of 8192
uncompressed bytes will be read at a time.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bzread-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the uncompressed data, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bzread-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-649">
<p><strong>Example #1 <span class="function"><strong>bzread()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">"/tmp/foo.bz2"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bz </span><span style="color: #007700">= </span><span style="color: #0000BB">bzopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Couldn't open </span><span style="color: #0000BB">$file</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$decompressed_file </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br />while (!</span><span style="color: #0000BB">feof</span><span style="color: #007700">(</span><span style="color: #0000BB">$bz</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$decompressed_file </span><span style="color: #007700">.= </span><span style="color: #0000BB">bzread</span><span style="color: #007700">(</span><span style="color: #0000BB">$bz</span><span style="color: #007700">, </span><span style="color: #0000BB">4096</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">bzclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$bz</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"The contents of </span><span style="color: #0000BB">$file</span><span style="color: #DD0000"> are: <br />\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$decompressed_file</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.bzread-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.bzwrite.html" class="function" rel="rdfs-seeAlso">bzwrite()</a> - Binary safe bzip2 file write</span></li>
<li class="member"> <span class="function"><a href="function.feof.html" class="function" rel="rdfs-seeAlso">feof()</a> - Tests for end-of-file on a file pointer</span></li>
<li class="member"> <span class="function"><a href="function.bzopen.html" class="function" rel="rdfs-seeAlso">bzopen()</a> - Opens a bzip2 compressed file</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.bzopen.html">bzopen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bzwrite.html">bzwrite</a></div>
<div class="up"><a href="ref.bzip2.html">Bzip2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
