<!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 write</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bzread.html">bzread</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.lzf.html">LZF</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.bzwrite" class="refentry">
<div class="refnamediv">
<h1 class="refname">bzwrite</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">bzwrite</span> — <span class="dc-title">Binary safe bzip2 file write</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bzwrite-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>bzwrite</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bz</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>bzwrite()</strong></span> writes a string into the given bzip2 file
stream.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bzwrite-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">data</code></em></span>
<dd>
<p class="para">
The written data.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">length</code></em></span>
<dd>
<p class="para">
If supplied, writing will stop after <em><code class="parameter">length</code></em>
(uncompressed) bytes have been written or the end of
<em><code class="parameter">data</code></em> is reached, whichever comes first.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bzwrite-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the number of bytes written, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bzwrite-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-650">
<p><strong>Example #1 <span class="function"><strong>bzwrite()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"uncompressed data"</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: #DD0000">"/tmp/foo.bz2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"w"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bzwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$bz</span><span style="color: #007700">, </span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">bzclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$bz</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.bzwrite-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.bzread.html" class="function" rel="rdfs-seeAlso">bzread()</a> - Binary safe bzip2 file read</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.bzread.html">bzread</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.lzf.html">LZF</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>
