nicobn Fri Aug 17 13:51:53 2007 UTC
Modified files:
/phpdoc/en/reference/sockets/functions socket-strerror.xml
Log:
Parameter explanation + note about locale + changed method synopsis a bit
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-strerror.xml?r1=1.10&r2=1.11&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-strerror.xml
diff -u phpdoc/en/reference/sockets/functions/socket-strerror.xml:1.10
phpdoc/en/reference/sockets/functions/socket-strerror.xml:1.11
--- phpdoc/en/reference/sockets/functions/socket-strerror.xml:1.10 Wed Jun
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-strerror.xml Fri Aug 17
13:51:53 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry xmlns="http://docbook.org/ns/docbook";
xml:id="function.socket-strerror">
<refnamediv>
<refname>socket_strerror</refname>
@@ -16,11 +16,15 @@
<function>socket_strerror</function> takes as its
<parameter>errno</parameter> parameter a socket error code as returned by
<function>socket_last_error</function> and returns the corresponding
- explanatory text. This makes it a bit more pleasant to figure out why
- something didn't work; for instance, instead of having to track down a
- system include file to find out what '-111' means, you just pass it to
- <function>socket_strerror</function>, and it tells you what happened.
+ explanatory text.
</para>
+ <note>
+ <para>
+ Although the error messages generated by the socket extension are in
+ English, the system messages retrieved with this function will appear
+ depending on the current locale (<constant>LC_MESSAGES</constant>).
+ </para>
+ </note>
</refsect1>
<refsect1 role="parameters">
@@ -31,6 +35,8 @@
<term><parameter>errno</parameter></term>
<listitem>
<para>
+ A valid socket error number, likely produced by
+ <function>socket_last_error</function>.
</para>
</listitem>
</varlistentry>
