Skip to content

Commit 6a7a96c

Browse files
authored
file_get_contents length parameter (#590)
* Rename maxlen parameter to length
1 parent f8476c9 commit 6a7a96c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

reference/filesystem/functions/file-get-contents.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
1515
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
1616
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
17-
<methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam>
17+
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
1818
</methodsynopsis>
1919
<para>
2020
This function is similar to <function>file</function>, except that
2121
<function>file_get_contents</function> returns the file in a
2222
<type>string</type>, starting at the specified <parameter>offset</parameter>
23-
up to <parameter>maxlen</parameter> bytes. On failure,
23+
up to <parameter>length</parameter> bytes. On failure,
2424
<function>file_get_contents</function> will return &false;.
2525
</para>
2626
<para>
@@ -89,7 +89,7 @@
8989
</listitem>
9090
</varlistentry>
9191
<varlistentry>
92-
<term><parameter>maxlen</parameter></term>
92+
<term><parameter>length</parameter></term>
9393
<listitem>
9494
<para>
9595
Maximum length of data read. The default is to read until end
@@ -113,7 +113,7 @@
113113
<refsect1 role="errors">
114114
&reftitle.errors;
115115
<para>
116-
An <constant>E_WARNING</constant> level error is generated if <parameter>filename</parameter> cannot be found, <parameter>maxlength</parameter>
116+
An <constant>E_WARNING</constant> level error is generated if <parameter>filename</parameter> cannot be found, <parameter>length</parameter>
117117
is less than zero, or if seeking to the specified <parameter>offset</parameter> in the stream fails.
118118
</para>
119119
<para>

0 commit comments

Comments
 (0)