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

[Markus Fischer]

mfischer                Tue Apr 30 18:11:48 2002 EDT

  Added files:                 
    /phpdoc/en/reference/sockets/functions      socket-clear-error.xml 

  Modified files:              
    /phpdoc/en/reference/sockets        functions.xml 
  Log:
  - Adding initial documentation for socket_clear_error()
  
  
Index: phpdoc/en/reference/sockets/functions.xml
diff -u phpdoc/en/reference/sockets/functions.xml:1.1 
phpdoc/en/reference/sockets/functions.xml:1.2
--- phpdoc/en/reference/sockets/functions.xml:1.1       Sun Apr 14 20:11:30 2002
+++ phpdoc/en/reference/sockets/functions.xml   Tue Apr 30 18:11:48 2002
@@ -1,5 +1,6 @@
 &reference.sockets.functions.socket-accept;
 &reference.sockets.functions.socket-bind;
+&reference.sockets.functions.socket-clear-error;
 &reference.sockets.functions.socket-close;
 &reference.sockets.functions.socket-connect;
 &reference.sockets.functions.socket-create;

Index: phpdoc/en/reference/sockets/functions/socket-clear-error.xml
+++ phpdoc/en/reference/sockets/functions/socket-clear-error.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
  <refentry id="function.socket-clear-error">
   <refnamediv>
    <refname>socket_clear_error</refname>
    <refpurpose>Clears the error on the socket or the last error code.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>socket_clearerror</methodname>
      <methodparam 
choice="opt"><type>resource</type><parameter>socket</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     This function clears the error code on the given socket or the global
     last socket error.
    </para>
    <para>
     This function allows explicitely resetting the error code value either of
     a socket or of the extension global last error code. This may be useful
     to detect within a part of the application if an error occured or not.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->