1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<?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 class="union"><type>string</type><type>false</type></type><methodname>inflate_add</methodname>
<methodparam><type>InflateContext</type><parameter>context</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flush_mode</parameter><initializer><constant>ZLIB_SYNC_FLUSH</constant></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>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="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>context</parameter> expects an <classname>InflateContext</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->
|
