<!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>Opens a bzip2 compressed file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bzflush.html">bzflush</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bzread.html">bzread</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.bzopen" class="refentry">
<div class="refnamediv">
<h1 class="refname">bzopen</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">bzopen</span> — <span class="dc-title">Opens a bzip2 compressed file</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bzopen-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>bzopen</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$file</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$mode</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>bzopen()</strong></span> opens a bzip2 (.bz2) file for reading or
writing.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bzopen-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">file</code></dt>
<dd>
<p class="para">
The name of the file to open, or an existing stream resource.
</p>
</dd>
<dt>
<code class="parameter">mode</code></dt>
<dd>
<p class="para">
The modes 'r' (read), and 'w' (write) are supported.
Everything else will cause <span class="function"><strong>bzopen()</strong></span> to return <strong><code>FALSE</code></strong>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bzopen-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If the open fails, <span class="function"><strong>bzopen()</strong></span> returns <strong><code>FALSE</code></strong>, otherwise
it returns a pointer to the newly opened file.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bzopen-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-732">
<p><strong>Example #1 <span class="function"><strong>bzopen()</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"> for reading"</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 /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.bzopen-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.bzclose.html" class="function" rel="rdfs-seeAlso">bzclose()</a> - Close a bzip2 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.bzflush.html">bzflush</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bzread.html">bzread</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>
