jason Mon Jul 8 13:11:06 2002 EDT
Modified files:
/phpdoc/en/reference/sockets/functions socket-read.xml
Log:
Small corrections, and grammar fixes
Index: phpdoc/en/reference/sockets/functions/socket-read.xml
diff -u phpdoc/en/reference/sockets/functions/socket-read.xml:1.3
phpdoc/en/reference/sockets/functions/socket-read.xml:1.4
--- phpdoc/en/reference/sockets/functions/socket-read.xml:1.3 Wed May 1 12:33:46
2002
+++ phpdoc/en/reference/sockets/functions/socket-read.xml Mon Jul 8 13:11:05
+2002
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.8 -->
<refentry id="function.socket-read">
<refnamediv>
<refname>socket_read</refname>
- <refpurpose>Reads a maximum of length bytes from socket</refpurpose>
+ <refpurpose>Reads a maximum of length bytes from a socket</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -16,22 +16,23 @@
</methodsynopsis>
&warn.experimental.func;
<para>
- The function <function>socket_read</function> reads from socket
- <parameter>socket</parameter> created by the
- <function>socket_accept</function> function the maximum number of bytes set by
- <parameter>length</parameter>. Otherwise you can use \r, \n or \0 to
- end reading (depending on the <parameter>type</parameter> parameter, see
- below).
+ The function <function>socket_read</function> reads from the socket
+ resource <parameter>socket</parameter> created by the
+ <function>socket_create</function> or
+ <function>socket_accept</function> functions. The maximum number of bytes read
+ is specified by the <parameter>length</parameter> parameter. Otherwise
+ you can use \r, \n, or \0 to end reading
+ (depending on the <parameter>type</parameter> parameter, see below).
</para>
<para>
- Returns the data as string on success, &false; on error. The error code
- can be retrieved with <function>socket_last_error</function>. This code
- may be passed to <function>socket_strerror</function> to get a textual
- explanation of the error.
+ <function>socket_read</function> returns the data as a string on success, or
+ &false; on error. The error code can be retrieved with
+<function>socket_last_error</function>.
+ This code may be passed to <function>socket_strerror</function> to get a textual
+ representation of the error.
</para>
<note>
<para>
- <function>socket_read</function> may return a zero length string
+ <function>socket_read</function> may return a zero length string ("")
indicating the end of communication (i.e. the remote end point has
closed the connection).
</para>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
