[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-bind.xml

[Markus Fischer]

mfischer                Wed May  1 04:59:09 2002 EDT

  Modified files:              
    /phpdoc/en/reference/sockets/functions      socket-bind.xml 
  Log:
  - Update docs.
  
  
Index: phpdoc/en/reference/sockets/functions/socket-bind.xml
diff -u phpdoc/en/reference/sockets/functions/socket-bind.xml:1.2 
phpdoc/en/reference/sockets/functions/socket-bind.xml:1.3
--- phpdoc/en/reference/sockets/functions/socket-bind.xml:1.2   Wed Apr 17 02:44:06 
2002
+++ phpdoc/en/reference/sockets/functions/socket-bind.xml       Wed May  1 04:59:09 
+2002
@@ -1,5 +1,5 @@
 <?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.3 -->
   <refentry id="function.socket-bind">
    <refnamediv>
@@ -9,17 +9,17 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>socket_bind</methodname>
+      <type>bool</type><methodname>socket_bind</methodname>
       <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
       <methodparam><type>string</type><parameter>address</parameter></methodparam>
       <methodparam 
choice="opt"><type>int</type><parameter>port</parameter></methodparam>
      </methodsynopsis>
-       &warn.experimental.func;
+    &warn.experimental.func;
     <para>
      <function>socket_bind</function> binds the name given in
      <parameter>address</parameter> to the socket described by
      <parameter>socket</parameter>, which must be a valid socket
-     descriptor created with <function>socket_create</function>.
+     resource created with <function>socket_create</function>.
     </para>
     <para>
      The <parameter>address</parameter> parameter is either an IP
@@ -36,15 +36,17 @@
      should be made.
     </para>
     <para>
-     Returns zero on success, or a negative error code on
-     failure. This code may be passed to <function>socket_strerror</function>
-     to get a textual explanation of the error.
+     Returns &true; on success, or a &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.
     </para>
     <para>
-     See also 
+     See also
      <function>socket_connect</function>,
      <function>socket_listen</function>,
-     <function>socket_create</function>, and
+     <function>socket_create</function>,
+     <function>socket_last_error</function> and
      <function>socket_strerror</function>.
     </para>
    </refsect1>