get-strength.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: takagi Status: ready -->
<refentry xml:id="collator.getstrength" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Collator::getStrength</refname>
  <refname>collator_get_strength</refname>
  <refpurpose>現在の照合強度を取得する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="Collator">
   <modifier>public</modifier> <type>int</type><methodname>Collator::getStrength</methodname>
   <void/>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type>int</type><methodname>collator_get_strength</methodname>
   <methodparam><type>Collator</type><parameter>object</parameter></methodparam>
  </methodsynopsis>
  <para>
   <!-- description goes here -->
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>object</parameter></term>
     <listitem>
      <para>
       <classname>Collator</classname> オブジェクト。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>


 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   現在の照合強度を返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>collator_get_strength</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$coll     = collator_create( 'en_US' );
$strength = collator_get_strength( $coll );
?>
]]>
    </programlisting>
<!--
    &example.outputs;
    <screen>
<![CDATA[
// TODO
]]>
    </screen>
-->
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="intl.collator-constants"><classname>Collator</classname> の定数</link></member>
    <member><function>collator_set_strength</function></member>
    <member><function>collator_get_attribute</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
-->