Document binary safety for fgets.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@100232 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Wez Furlong 2002-10-19 13:25:47 +00:00
parent de10ad4d95
commit 2284f46e83

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fgets">
<refnamediv>
@ -54,7 +54,19 @@ fclose ($fd);
</para>
<note>
<simpara>
The <parameter>length</parameter> parameter became optional in PHP 4.2.0
The <parameter>length</parameter> parameter became optional in PHP
4.2.0, if omitted, it would assume 1024 as the line length.
As of PHP 4.3, omitting <parameter>length</parameter> will keep
reading from the stream until it reaches the end of the line.
If the majority of the lines in the file are all larger than 8KB,
it is more resource efficient for your script to specify the maximum
line length.
</simpara>
</note>
<note>
<simpara>
This function is binary safe as of PHP 4.3. Earlier versions
were not binary safe.
</simpara>
</note>
&note.line-endings;