<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.strcoll" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strcoll</refname>
  <refpurpose>Locale based string comparison</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>strcoll</methodname>
   <methodparam><type>string</type><parameter>string1</parameter></methodparam>
   <methodparam><type>string</type><parameter>string2</parameter></methodparam>
  </methodsynopsis>
  <para>
   Note that this comparison is case sensitive, and unlike
   <function>strcmp</function> this function is not binary safe.
  </para>
  <para>
   <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>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string1</parameter></term>
     <listitem>
      <para>
       The first string.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string2</parameter></term>
     <listitem>
      <para>
       The second string.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &lt; 0 if <parameter>string1</parameter> is less than
   <parameter>string2</parameter>; &gt; 0 if
   <parameter>string1</parameter> is greater than
   <parameter>string2</parameter>, and 0 if they are equal.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>preg_match</function></member>
    <member><function>strcmp</function></member>
    <member><function>strcasecmp</function></member>
    <member><function>substr</function></member>
    <member><function>stristr</function></member>
    <member><function>strncasecmp</function></member>
    <member><function>strncmp</function></member>
    <member><function>strstr</function></member>
    <member><function>setlocale</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->
