reference/intl/intlchar/getpropertyvaluename.xml
1976eae0d815797af97a1e16c5cd90ffc2868395
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="intlchar.getpropertyvaluename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>IntlChar::getPropertyValueName</refname>
...
...
@@ -9,11 +8,11 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>IntlChar::getPropertyValueName</methodname>
11
+
<methodsynopsis role="IntlChar">
12
+
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>IntlChar::getPropertyValueName</methodname>
14
13
<methodparam><type>int</type><parameter>property</parameter></methodparam>
15
14
<methodparam><type>int</type><parameter>value</parameter></methodparam>
16
-
<methodparam choice="opt"><type>int</type><parameter>nameChoice</parameter><initializer><constant>IntlChar::LONG_PROPERTY_NAME</constant></initializer></methodparam>
15
+
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IntlChar::LONG_PROPERTY_NAME</initializer></methodparam>
17
16
</methodsynopsis>
18
17
<para>
19
18
Returns the Unicode name for a given property value, as given in the Unicode database file PropertyValueAliases.txt.
...
...
@@ -70,7 +69,7 @@
70
69
</listitem>
71
70
</varlistentry>
72
71
<varlistentry>
73
-
<term><parameter>nameChoice</parameter></term>
72
+
<term><parameter>type</parameter></term>
74
73
<listitem>
75
74
<para>
76
75
Selector for which name to get. If out of range, &false; is returned.
...
...
@@ -87,11 +86,11 @@
87
86
<refsect1 role="returnvalues">
88
87
&reftitle.returnvalues;
89
88
<para>
90
-
Returns the name, or &false; if either the <parameter>property</parameter> or the <parameter>nameChoice</parameter>
91
-
is out of range.
89
+
Returns the name, or &false; if either the <parameter>property</parameter> or the <parameter>type</parameter>
90
+
is out of range. Returns &null; on failure.
92
91
</para>
93
92
<para>
94
-
If a given <parameter>nameChoice</parameter> returns &false;, then all larger values of <parameter>nameChoice</parameter>
93
+
If a given <parameter>type</parameter> returns &false;, then all larger values of <parameter>type</parameter>
95
94
will return &false;, with one exception: if &false; is returned for <constant>IntlChar::SHORT_PROPERTY_NAME</constant>,
96
95
then <constant>IntlChar::LONG_PROPERTY_NAME</constant> (and higher) may still return a non-&false; value.
97
96
</para>
...
...
@@ -124,7 +123,6 @@ bool(false)
124
123
</refsect1>
125
124

126
125
</refentry>
127
-

128
126
<!-- Keep this comment at the end of the file
129
127
Local variables:
130
128
mode: sgml
131
129