reference/zlib/functions/gzgets.xml
c2120bd346716d6b7fc7cf777a2b0717f7b45f5f
c2120bd346716d6b7fc7cf777a2b0717f7b45f5f
...
...
@@ -8,9 +8,9 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>string</type><methodname>gzgets</methodname>
12
-
<methodparam><type>resource</type><parameter>zp</parameter></methodparam>
13
-
<methodparam><type>int</type><parameter>length</parameter></methodparam>
11
+
<type class="union"><type>string</type><type>false</type></type><methodname>gzgets</methodname>
12
+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
Gets a (uncompressed) string of up to length - 1 bytes read from the given
...
...
@@ -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
...
...
@@ -48,6 +48,30 @@
48
48
The uncompressed string, or &false; on error.
49
49
</para>
50
50
</refsect1>
51
+
52
+
<refsect1 role="changelog">
53
+
&reftitle.changelog;
54
+
<informaltable>
55
+
<tgroup cols="2">
56
+
<thead>
57
+
<row>
58
+
<entry>&Version;</entry>
59
+
<entry>&Description;</entry>
60
+
</row>
61
+
</thead>
62
+
<tbody>
63
+
<row>
64
+
<entry>8.0.0</entry>
65
+
<entry>
66
+
<parameter>length</parameter> is nullable now;
67
+
previously, the default was <literal>1024</literal>.
68
+
</entry>
69
+
</row>
70
+
</tbody>
71
+
</tgroup>
72
+
</informaltable>
73
+
</refsect1>
74
+
51
75
<refsect1 role="examples">
52
76
&reftitle.examples;
53
77
<para>
...
...
@@ -79,7 +103,6 @@ gzclose($handle);
79
103
</para>
80
104
</refsect1>
81
105
</refentry>
82
-
83
106
<!-- Keep this comment at the end of the file
84
107
Local variables:
85
108
mode: sgml
86
109