<!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>Decompresses bzip2 encoded data</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bzcompress.html">bzcompress</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bzerrno.html">bzerrno</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.bzdecompress" class="refentry">
<div class="refnamediv">
<h1 class="refname">bzdecompress</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">bzdecompress</span> — <span class="dc-title">Decompresses bzip2 encoded data</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bzdecompress-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>bzdecompress</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$source</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$small</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>bzdecompress()</strong></span> decompresses the given string containing
bzip2 encoded data.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bzdecompress-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">source</code></em></span>
<dd>
<p class="para">
The string to decompress.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">small</code></em></span>
<dd>
<p class="para">
If <strong><code>TRUE</code></strong>, an alternative decompression algorithm will be used which
uses less memory (the maximum memory requirement drops to around 2300K)
but works at roughly half the speed.
</p>
<p class="para">
See the <a href="http://www.bzip.org/" class="link external">» bzip2 documentation</a> for more
information about this feature.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bzdecompress-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The decompressed string, or an error number if an error occurred.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bzdecompress-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-646">
<p><strong>Example #1 Decompressing a String</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$start_str </span><span style="color: #007700">= </span><span style="color: #DD0000">"This is not an honest face?"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bzstr </span><span style="color: #007700">= </span><span style="color: #0000BB">bzcompress</span><span style="color: #007700">(</span><span style="color: #0000BB">$start_str</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Compressed String: "</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$bzstr</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\n<br />\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">bzdecompress</span><span style="color: #007700">(</span><span style="color: #0000BB">$bzstr</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Decompressed String: "</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$str</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\n<br />\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.bzdecompress-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.bzcompress.html" class="function" rel="rdfs-seeAlso">bzcompress()</a> - Compress a string into bzip2 encoded data</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.bzcompress.html">bzcompress</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bzerrno.html">bzerrno</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>
