 |
 |
 |
 |
|
|
Date: 05/25/00
- Next message: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /de/functions/ var.xml /en/functions/ var.xml"
- Previous message: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /en/functions/ image.xml session.xml var.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
hholzgra Thu May 25 18:26:42 2000 EDT
Modified files:
/phpdoc/en/functions zlib.xml
Log:
added documentation for functions gzcompress() and gzuncompress()
Index: phpdoc/en/functions/zlib.xml
diff -u phpdoc/en/functions/zlib.xml:1.3 phpdoc/en/functions/zlib.xml:1.4
--- phpdoc/en/functions/zlib.xml:1.3 Fri Mar 24 15:43:15 2000
+++ phpdoc/en/functions/zlib.xml Thu May 25 18:26:42 2000
@@ -515,6 +515,56 @@
</refsect1>
</refentry>
+ <refentry id="function.gzcompress">
+ <refnamediv>
+ <refname>gzcompress</refname>
+ <refpurpose>gz-compress a string</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>string <function>gzcompress</function></funcdef>
+ <paramdef>string <parameter>data</parameter></paramdef>
+ <paramdef>int <parameter><optional>level</optional></parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ This function returns a gzip-compressed version of the input
+ <parameter>data</parameter> or false on errors. The optional parameter
+ <parameter>level</parameter> can be given as 0 for no compression
+ up to 9 for maximum compression.
+ </para>
+ <para>
+ See also <function>gzuncompress</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.gzuncompress">
+ <refnamediv>
+ <refname>gzuncompress</refname>
+ <refpurpose>uncompress a gz-compressed string</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>string <function>gzcompress</function></funcdef>
+ <paramdef>string <parameter>data</parameter></paramdef>
+ <paramdef>int <parameter><optional>length</optional></parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ This function takes <parameter>data</parameter> compressed by
+ <function>gzcompress</function> and returns the orignial uncompressed
+ data or false on error.
+ The function will return an error if the uncompressed data is more then 256
+ times the lenght of the compressed input <parameter>data</parameter> or more
+ than the optional parameter <parameter>length</parameter>.
+ </para>
+ <para>
+ See also <function>gzcompress</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
</reference>
<!-- Keep this comment at the end of the file
- Next message: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /de/functions/ var.xml /en/functions/ var.xml"
- Previous message: Hartmut Holzgraefe: "[PHPDOC] cvs: phpdoc /en/functions/ image.xml session.xml var.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]