cvs: phpdoc /en/reference/filesystem/functions fread.xml

vrana Wed Nov 21 15:18:39 2007 UTC Modified files: /phpdoc/en/reference/filesystem/functions fread.xml Log: List reading stop (bug #42827) http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/fread.xml?r1=1.24&r2=1.25&diff_format=u Index: phpdoc/en/reference/filesystem/functions/fread.xml diff -u phpdoc/en/reference/filesystem/functions/fread.xml:1.24 phpdoc/en/reference/filesystem/functions/fread.xml:1.25 --- phpdoc/en/reference/filesystem/functions/fread.xml:1.24 Sat Sep 15 02:44:00 2007 +++ phpdoc/en/reference/filesystem/functions/fread.xml Wed Nov 21 15:18:39 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.24 $ --> +<!-- $Revision: 1.25 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fread"> <refnamediv> <refname>fread</refname> @@ -13,15 +13,34 @@ <methodparam><type>resource</type><parameter>handle</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> </methodsynopsis> - <simpara> + <para> <function>fread</function> reads up to <parameter>length</parameter> bytes from the file pointer - referenced by <parameter>handle</parameter>. Reading stops when up to - <parameter>length</parameter> bytes have been read, EOF - (end of file) is reached, (for network streams) when a packet becomes - available, or (after opening userspace stream) when 8192 bytes have been read - whichever comes first. - </simpara> + referenced by <parameter>handle</parameter>. Reading stops as soon as one + of the following conditions is met: + <itemizedlist> + <listitem> + <simpara> + <parameter>length</parameter> bytes have been read + </simpara> + </listitem> + <listitem> + <simpara> + EOF (end of file) is reached + </simpara> + </listitem> + <listitem> + <simpara> + a packet becomes available (for network streams) + </simpara> + </listitem> + <listitem> + <simpara> + 8192 bytes have been read (after opening userspace stream) + </simpara> + </listitem> + </itemizedlist> + </para> </refsect1> <refsect1 role="parameters">