sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

added documentation for functions gzcompress() and gzuncompress()

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@25040 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2000-05-25 16:26:42 +00:00
parent cd3ddfee05
commit 9ecc46f34d
1 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
functions/zlib.xml
View file

@ -515,6 +515,56 @@ gzclose( $zd );
</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