[PHP-DOC] cvs: phpdoc /en/functions strings.xml

[Sean Bright]

elixer          Sat Jan 20 11:12:53 2001 EDT

  Modified files:              
    /phpdoc/en/functions        strings.xml 
  Log:
  Added strcoll() documentation
  
  
Index: phpdoc/en/functions/strings.xml
diff -u phpdoc/en/functions/strings.xml:1.68 phpdoc/en/functions/strings.xml:1.69
--- phpdoc/en/functions/strings.xml:1.68        Tue Jan 16 15:26:07 2001
+++ phpdoc/en/functions/strings.xml     Sat Jan 20 11:12:53 2001
@@ -2051,6 +2051,47 @@
    </refsect1>
   </refentry>
 
+  <refentry id="function.strcoll">
+   <refnamediv>
+    <refname>strcoll</refname>
+    <refpurpose>Locale based string comparison</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>strcoll</function></funcdef>
+      <paramdef>string <parameter>str1</parameter></paramdef>
+      <paramdef>string <parameter>str2</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <simpara>
+     Returns &lt; 0 if <parameter>str1</parameter> is less than
+     <parameter>str2</parameter>; &gt; 0 if <parameter>str1</parameter>
+     is greater than <parameter>str2</parameter>, and 0 if they are
+     equal.  <function>strcoll</function> uses the current locale for
+     doing the comparisons.  If the current locale is C or POSIX, this
+     function is equivalent to <function>strcmp</function>.
+    </simpara>
+    <simpara>
+     Note that this comparison is case sensitive, and unlike
+     <function>strcmp</function> this function is not binary safe.
+    </simpara>
+    <note>
+     <simpara>
+      Added in PHP 4.0.5.
+     </simpara>
+    </note>
+    <simpara>
+     See also <function>ereg</function>, <function>strcmp</function>,
+     <function>strcasecmp</function>, <function>substr</function>,
+     <function>stristr</function>, <function>strncasecmp</function>,
+     <function>strncmp</function>, <function>strstr</function>,
+     and <function>setlocale</function>.
+    </simpara>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.strcspn">
    <refnamediv>
     <refname>strcspn</refname>