1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.foldcase" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::foldCase</refname>
<refpurpose>Perform case folding on a code point</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="IntlChar">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>int</type><type>string</type><type>null</type></type><methodname>IntlChar::foldCase</methodname>
<methodparam><type class="union"><type>int</type><type>string</type></type><parameter>codepoint</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>IntlChar::FOLD_CASE_DEFAULT</initializer></methodparam>
</methodsynopsis>
<para>
The given character is mapped to its case folding equivalent; if the character has no case folding equivalent,
the character itself is returned.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>codepoint</parameter></term>
<listitem>
&intl.codepoint.parameter;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Either <constant>IntlChar::FOLD_CASE_DEFAULT</constant> (default)
or <constant>IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the <emphasis>Simple_Case_Folding</emphasis> of the code point, if any; otherwise the code point itself on success,
or &null; on failure.
</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
-->
|