mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 13:28:56 +00:00
5f177879f0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339759 c90b9560-bf6c-de11-be94-00142212c4b1
111 lines
3.3 KiB
XML
111 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.inflate-add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>inflate_add</refname>
|
|
<refpurpose>Incrementally inflate encoded data</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description"><!-- {{{ -->
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>inflate_add</methodname>
|
|
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>encoded_data</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flush_mode</parameter><initializer>ZLIB_SYNC_FLUSH</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Incrementally inflates encoded data in the specified <parameter>context</parameter>.
|
|
</para>
|
|
<para>
|
|
Limitation: header information from GZIP compressed data are not made
|
|
available.
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="parameters"><!-- {{{ -->
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A context created with <function>inflate_init</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoded_data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A chunk of compressed data.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flush_mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of <constant>ZLIB_BLOCK</constant>,
|
|
<constant>ZLIB_NO_FLUSH</constant>,
|
|
<constant>ZLIB_PARTIAL_FLUSH</constant>,
|
|
<constant>ZLIB_SYNC_FLUSH</constant> (default),
|
|
<constant>ZLIB_FULL_FLUSH</constant>, <constant>ZLIB_FINISH</constant>.
|
|
Normally you will want to set <constant>ZLIB_NO_FLUSH</constant> to
|
|
maximize compression, and <constant>ZLIB_FINISH</constant> to terminate
|
|
with the last chunk of data. See the <link
|
|
xlink:href="http://www.zlib.net/manual.html">zlib manual</link> for a
|
|
detailed description of these constants.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="returnvalues"><!-- {{{ -->
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a chunk of uncompressed data, &return.falseforfailure;.
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="errors"><!-- {{{ -->
|
|
&reftitle.errors;
|
|
<para>
|
|
If invalid parameters are given, inflating the data requires a preset
|
|
dictionary, but none is specified, the compressed stream is corrupt or has an
|
|
invalid checksum, an error of level <constant>E_WARNING</constant> is
|
|
generated.
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="seealso"><!-- {{{ -->
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>inflate_init</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|