mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
a99a584108
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308599 c90b9560-bf6c-de11-be94-00142212c4b1
113 lines
2.9 KiB
XML
113 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.bzread" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>bzread</refname>
|
|
<refpurpose>Binary safe bzip2 file read</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>bzread</methodname>
|
|
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1024</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>bzread</function> reads from the given bzip2 file pointer.
|
|
</para>
|
|
<para>
|
|
Reading stops when <parameter>length</parameter> (uncompressed) bytes have
|
|
been read or EOF is reached, whichever comes first.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>bz</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The file pointer. It must be valid and must point to a file
|
|
successfully opened by <function>bzopen</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If not specified, <function>bzread</function> will read 1024
|
|
(uncompressed) bytes at a time. A maximum of 8192
|
|
uncompressed bytes will be read at a time.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the uncompressed data, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>bzread</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$file = "/tmp/foo.bz2";
|
|
$bz = bzopen($file, "r") or die("Couldn't open $file");
|
|
|
|
$decompressed_file = '';
|
|
while (!feof($bz)) {
|
|
$decompressed_file .= bzread($bz, 4096);
|
|
}
|
|
bzclose($bz);
|
|
|
|
echo "The contents of $file are: <br />\n";
|
|
echo $decompressed_file;
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>bzwrite</function></member>
|
|
<member><function>feof</function></member>
|
|
<member><function>bzopen</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|