Add documentation as per mr. zmievski's request

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@63889 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sterling Hughes 2001-12-04 20:10:08 +00:00
parent 19459d62fa
commit 7c9f531fbf

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.91 $ -->
<!-- $Revision: 1.92 $ -->
<reference id="ref.filesystem">
<title>Filesystem functions</title>
<titleabbrev>Filesystem</titleabbrev>
@ -595,14 +595,15 @@ fclose ($fp);
<funcprototype>
<funcdef>string <function>fgets</function></funcdef>
<paramdef>int <parameter>fp</parameter></paramdef>
<paramdef>int <parameter>length</parameter></paramdef>
<paramdef>int <parameter><optional>length</optional></parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns a string of up to length - 1 bytes read from the file
pointed to by fp. Reading ends when length - 1 bytes have been
read, on a newline (which is included in the return value), or on
EOF (whichever comes first).
EOF (whichever comes first). If no length is specified, the length
defaults to 1k, or 1024 bytes.
</para>
<para>
If an error occurs, returns &false;.