reference/zlib/functions/gzwrite.xml
9d2b858bca85edbeebb83f05a1cd2e87cf90127d
9d2b858bca85edbeebb83f05a1cd2e87cf90127d
...
...
@@ -8,14 +8,14 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>int</type><methodname>gzwrite</methodname>
12
-
<methodparam><type>resource</type><parameter>zp</parameter></methodparam>
13
-
<methodparam><type>string</type><parameter>string</parameter></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
11
+
<type class="union"><type>int</type><type>false</type></type><methodname>gzwrite</methodname>
12
+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>data</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>gzwrite</function> writes the contents of
18
-
<parameter>string</parameter> to the given gz-file.
18
+
<parameter>data</parameter> to the given gz-file.
19
19
</para>
20
20
</refsect1>
21
21
<refsect1 role="parameters">
...
...
@@ -23,7 +23,7 @@
23
23
<para>
24
24
<variablelist>
25
25
<varlistentry>
26
-
<term><parameter>zp</parameter></term>
26
+
<term><parameter>stream</parameter></term>
27
27
<listitem>
28
28
<para>
29
29
The gz-file pointer. It must be valid, and must point to a file
...
...
@@ -32,7 +32,7 @@
32
32
</listitem>
33
33
</varlistentry>
34
34
<varlistentry>
35
-
<term><parameter>string</parameter></term>
35
+
<term><parameter>data</parameter></term>
36
36
<listitem>
37
37
<para>
38
38
The string to write.
...
...
@@ -45,18 +45,9 @@
45
45
<para>
46
46
The number of uncompressed bytes to write. If supplied, writing will
47
47
stop after <parameter>length</parameter> (uncompressed) bytes have been
48
-
written or the end of <parameter>string</parameter> is reached,
48
+
written or the end of <parameter>data</parameter> is reached,
49
49
whichever comes first.
50
50
</para>
51
-
<note>
52
-
<para>
53
-
Note that if the <parameter>length</parameter> argument is given,
54
-
then the <link
55
-
linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>
56
-
configuration option will be ignored and no slashes will be
57
-
stripped from <parameter>string</parameter>.
58
-
</para>
59
-
</note>
60
51
</listitem>
61
52
</varlistentry>
62
53
</variablelist>
...
...
@@ -66,9 +57,39 @@
66
57
&reftitle.returnvalues;
67
58
<para>
68
59
Returns the number of (uncompressed) bytes written to the given gz-file
69
-
stream.
60
+
stream, &return.falseforfailure;.
70
61
</para>
71
62
</refsect1>
63
+
64
+
<refsect1 role="changelog">
65
+
&reftitle.changelog;
66
+
<informaltable>
67
+
<tgroup cols="2">
68
+
<thead>
69
+
<row>
70
+
<entry>&Version;</entry>
71
+
<entry>&Description;</entry>
72
+
</row>
73
+
</thead>
74
+
<tbody>
75
+
<row>
76
+
<entry>8.0.0</entry>
77
+
<entry>
78
+
<parameter>length</parameter> is nullable now; previously, the default was
79
+
<literal>0</literal>.
80
+
</entry>
81
+
</row>
82
+
<row>
83
+
<entry>7.4.0</entry>
84
+
<entry>
85
+
This functions returns &false; on failure now; previously <literal>0</literal> was returned.
86
+
</entry>
87
+
</row>
88
+
</tbody>
89
+
</tgroup>
90
+
</informaltable>
91
+
</refsect1>
92
+
72
93
<refsect1 role="examples">
73
94
&reftitle.examples;
74
95
<para>
...
...
@@ -97,7 +118,6 @@ gzclose($gz);
97
118
</para>
98
119
</refsect1>
99
120
</refentry>
100
-
101
121
<!-- Keep this comment at the end of the file
102
122
Local variables:
103
123
mode: sgml
104
124