small addition to resource type usage of this extension.

changed the return type of bzopen to resource and the related function protos using this resource.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@75150 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Friedhelm Betz 2002-03-25 13:52:58 +00:00
parent 19f61d1cf8
commit c4a1804e83

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<!-- $Revision: 1.18 $ -->
<reference id="ref.bzip2">
<title>Bzip2 Compression Functions</title>
<titleabbrev>Bzip2</titleabbrev>
@ -38,7 +38,8 @@
<section id="bzip2.resources">
<title>Resource types</title>
<para>
This extension does not define any resource types.
This extension defines one resource type: a file pointer identifying
the bz2-file to work on.
</para>
</section>
@ -101,7 +102,7 @@ bzclose($bz);
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>bzclose</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
</methodsynopsis>
<para>
Closes the bzip2 file referenced by the pointer <parameter>bz</parameter>.
@ -234,7 +235,7 @@ print( "\n<br>\n" );
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>bzerrno</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
</methodsynopsis>
<para>
Returns the error number of any bzip2 error returned by the file
@ -256,7 +257,7 @@ print( "\n<br>\n" );
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>bzerror</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
</methodsynopsis>
<para>
Returns the error number and error string, in an associative array,
@ -294,7 +295,7 @@ echo $error["errstr"];
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bzerrstr</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
</methodsynopsis>
<para>
Returns the error string of any bzip2 error returned by the file
@ -316,7 +317,7 @@ echo $error["errstr"];
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>bzflush</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
</methodsynopsis>
<para>
Forces a write of all buffered bzip2 data for the file pointer
@ -340,7 +341,7 @@ echo $error["errstr"];
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>bzopen</methodname>
<type>resource</type><methodname>bzopen</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
@ -388,7 +389,7 @@ print( $decompressed_file );
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bzread</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
@ -431,7 +432,7 @@ print( $str );
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>bzwrite</methodname>
<methodparam><type>int</type><parameter>bz</parameter></methodparam>
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>