archived-doc-ja/reference/com/functions/variant-cmp.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 20216b916ed583938672cd09c2c2f430351430d1 Maintainer: takagi Status: ready -->
<refentry xml:id="function.variant-cmp" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>variant_cmp</refname>
  <refpurpose>2 つの variant を比較する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>variant_cmp</methodname>
   <methodparam><type>mixed</type><parameter>left</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>right</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>locale_id</parameter><initializer><constant>LOCALE_SYSTEM_DEFAULT</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>left</parameter> と <parameter>right</parameter>
   を比較します。
  </para>
  <para>
   この関数はスカラー値のみを比較します。配列や variant レコードは比較しません。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>left</parameter></term>
     <listitem>
      <para>
       左オペランド。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>right</parameter></term>
     <listitem>
      <para>
       右オペランド。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>locale_id</parameter></term>
     <listitem>
      <para>
       文字列の比較に使用する有効なロケール識別子です
       (これは文字列の比較に影響します)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> は、以下のひとつあるいは複数の値を
       OR で組み合わせたもので、文字列の比較に影響します。
       <table>
        <title>Variant の比較フラグ</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>値</entry>
           <entry>意味</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>NORM_IGNORECASE</constant></entry>
           <entry>大文字小文字を区別せずに比較する</entry>
          </row>
          <row>
           <entry><constant>NORM_IGNORENONSPACE</constant></entry>
           <entry>非スペーシング文字を無視する</entry>
          </row>
          <row>
           <entry><constant>NORM_IGNORESYMBOLS</constant></entry>
           <entry>記号を無視する</entry>
          </row>
          <row>
           <entry><constant>NORM_IGNOREWIDTH</constant></entry>
           <entry>全角半角を区別しない</entry>
          </row>
          <row>
           <entry><constant>NORM_IGNOREKANATYPE</constant></entry>
           <entry>ひらがなカタカナを区別しない</entry>
          </row>
          <row>
           <entry><constant>NORM_IGNOREKASHIDA</constant></entry>
           <entry>アラビア語の kashida 文字を無視する</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  &com.variant-arith;
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   以下のいずれかを返します。
   <table>
    <title>Variant の比較結果</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>値</entry>
       <entry>意味</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><constant>VARCMP_LT</constant></entry>
       <entry><parameter>left</parameter> は
        <parameter>right</parameter> より小さい
       </entry>
      </row>
      <row>
       <entry><constant>VARCMP_EQ</constant></entry>
       <entry><parameter>left</parameter> は
        <parameter>right</parameter> と等しい
       </entry>
      </row>
      <row>
       <entry><constant>VARCMP_GT</constant></entry>
       <entry><parameter>left</parameter> は
        <parameter>right</parameter> より大きい
       </entry>
      </row>
      <row>
       <entry><constant>VARCMP_NULL</constant></entry>
       <entry><parameter>left</parameter> と
        <parameter>right</parameter> のいずれか、あるいは両方が &null;
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </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
-->