[PHP-DOC] cvs: phpdoc /en/functions strings.xml From: Dan Kalowsky (dkalowsky <email protected>)
Date: 12/11/00

kalowsky Mon Dec 11 12:50:52 2000 EDT

  Modified files:
    /phpdoc/en/functions strings.xml
  Log:
  added in documentation to the strncasecmp function. written by kevin way (kway <email protected>)
  
  
  
  
Index: phpdoc/en/functions/strings.xml
diff -u phpdoc/en/functions/strings.xml:1.65 phpdoc/en/functions/strings.xml:1.66
--- phpdoc/en/functions/strings.xml:1.65 Tue Nov 21 17:43:30 2000
+++ phpdoc/en/functions/strings.xml Mon Dec 11 12:50:51 2000
@@ -1731,6 +1731,45 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.strncasecmp">
+ <refnamediv>
+ <refname>strncasecmp</refname>
+ <refpurpose>
+ Binary safe case-insensitive string comparison of the first n characters
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>strncasecmp</function></funcdef>
+ <paramdef>string <parameter>str1</parameter></paramdef>
+ <paramdef>string <parameter>str2</parameter></paramdef>
+ <paramdef>int <parameter>len</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function is similar to <function>strcasecmp</function>, with the
+ difference that you can specify the (upper limit of the) number of
+ characters (<parameter>len</parameter>) from each string to be
+ used in the comparison. If any of the strings is shorter than
+ <parameter>len</parameter>, then the length of that string will be
+ used for the comparison.
+ </para>
+ <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.
+ </simpara>
+ <simpara>
+ See also <function>ereg</function>, <function>strcasecmp</function>,
+ <function>strcmp</function>, <function>substr</function>,
+ <function>stristr</function>, and <function>strstr</function>.
+ </simpara>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.strcasecmp">
    <refnamediv>
     <refname>strcasecmp</refname>
@@ -1765,8 +1804,8 @@
     </para>
     <simpara>
      See also <function>ereg</function>, <function>strcmp</function>,
- <function>substr</function>, <function>stristr</function>, and
- <function>strstr</function>.
+ <function>substr</function>, <function>stristr</function>,
+ <function>strncasecmp</function>, and <function>strstr</function>.
     </simpara>
    </refsect1>
   </refentry>
@@ -1820,8 +1859,8 @@
     <simpara>
      See also <function>ereg</function>,
      <function>strcasecmp</function>, <function>substr</function>,
- <function>stristr</function>, <function>strncmp</function>,
- and <function>strstr</function>.
+ <function>stristr</function>, <function>strncasecmp</function>,
+ <function>strncmp</function>, and <function>strstr</function>.
     </simpara>
    </refsect1>
   </refentry>
@@ -2075,9 +2114,9 @@
      See also <function>ereg</function>,
      <function>strcasecmp</function>, <function>substr</function>,
      <function>stristr</function>, <function>strcmp</function>,
- <function>strncmp</function>, <function>strnatcasecmp</function>,
- <function>strstr</function>, <function>natsort</function> and
- <function>natcasesort</function>.
+ <function>strncmp</function>, <function>strncasecmp</function>,
+ <function>strnatcasecmp</function>, <function>strstr</function>,
+ <function>natsort</function> and <function>natcasesort</function>.
     </simpara>
    </refsect1>
   </refentry>
@@ -2118,8 +2157,8 @@
      See also <function>ereg</function>,
      <function>strcasecmp</function>, <function>substr</function>,
      <function>stristr</function>, <function>strcmp</function>,
- <function>strncmp</function>, <function>strnatcmp</function>,
- and <function>strstr</function>.
+ <function>strncmp</function>, <function>strncasecmp</function>,
+ <function>strnatcmp</function>, and <function>strstr</function>.
     </simpara>
    </refsect1>
   </refentry>
@@ -2159,7 +2198,7 @@
      Note that this comparison is case sensitive.
     </simpara>
     <simpara>
- See also <function>ereg</function>,
+ See also <function>ereg</function>, <function>strncasecmp</function>,
      <function>strcasecmp</function>, <function>substr</function>,
      <function>stristr</function>, <function>strcmp</function>,
          and <function>strstr</function>.