mfischer Wed May 1 05:04:04 2002 EDT
Modified files:
/phpdoc/en/reference/sockets/functions socket-close.xml
Log:
- Update docs.
Index: phpdoc/en/reference/sockets/functions/socket-close.xml
diff -u phpdoc/en/reference/sockets/functions/socket-close.xml:1.2
phpdoc/en/reference/sockets/functions/socket-close.xml:1.3
--- phpdoc/en/reference/sockets/functions/socket-close.xml:1.2 Wed Apr 17 02:44:06
2002
+++ phpdoc/en/reference/sockets/functions/socket-close.xml Wed May 1 05:04:04
+2002
@@ -1,37 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.1 -->
<refentry id="function.socket-close">
<refnamediv>
<refname>socket_close</refname>
- <refpurpose>Closes a socket descriptor</refpurpose>
+ <refpurpose>Closes a socket resource</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>bool</type><methodname>socket_close</methodname>
+ <type>void</type><methodname>socket_close</methodname>
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
+ &warn.experimental.func;
<para>
- <function>socket_close</function> closes the file (or socket) descriptor
+ <function>socket_close</function> closes the socket resource
given by <parameter>socket</parameter>.
</para>
- <para>
- Note that <function>socket_close</function> should not be used on PHP
- file descriptors created with <function>fopen</function>,
- <function>popen</function>, <function>fsockopen</function>, or
- <function>psockopen</function>; it is meant for sockets created
- with <function>socket_create</function> or
- <function>socket_accept</function>.
- </para>
- <para>
- Returns &true; on success, or &false;
- if an error occurs (i.e., <parameter>socket</parameter> is invalid).
- </para>
+ <note>
+ <para>
+ <function>socket_close</function> can't be used on PHP file resources
+ created with <function>fopen</function>, <function>popen</function>,
+ <function>fsockopen</function>, or <function>psockopen</function>; it is
+ meant for sockets created with <function>socket_create</function> or
+ <function>socket_accept</function>.
+ </para>
+ </note>
<para>
See also <function>socket_bind</function>, <function>socket_listen</function>,
- <function>socket_create</function>, and
+ <function>socket_create</function> and
<function>socket_strerror</function>.
</para>
</refsect1>
