cvs: phpdoc /en/functions bzip2.xml
| From: | Friedhelm Betz | Date: | Mon, 25 Mar 2002 13:52:58 +0000 |
| Subject: | cvs: phpdoc /en/functions bzip2.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969343443@lists.php.net to get a copy of this message | ||
betz Mon Mar 25 08:52:58 2002 EDT
Modified files:
/phpdoc/en/functions bzip2.xml
Log:
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.
Index: phpdoc/en/functions/bzip2.xml
diff -u phpdoc/en/functions/bzip2.xml:1.17 phpdoc/en/functions/bzip2.xml:1.18
--- phpdoc/en/functions/bzip2.xml:1.17 Mon Mar 11 02:30:20 2002
+++ phpdoc/en/functions/bzip2.xml Mon Mar 25 08:52:58 2002
@@ -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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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>