NameByNumber (UnicodeNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (update syntax terms to match corrected template)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Template:UnicodeNamedArraylist:NameByNumber subtitle}}
{{Template:UnicodeNamedArraylist:NameByNumber subtitle}}


The <var>NameByNumber</var> ReadOnly property returns the subscript name of the item that has the specified item <var class="term">number</var> (position) in the <var>UnicodeNamedArraylist</var>.
<var>NameByNumber</var> returns the subscript name of the item that has the specified item <var class="term">number</var> (position) in the <var>UnicodeNamedArraylist</var>.


==Syntax==
==Syntax==
Line 14: Line 14:
<td>A whole number greater than 0 to identify a <var class="term">uniNal</var> item by its position (item number) in the <var>UnicodeNamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">uniNal</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr>
<td>A whole number greater than 0 to identify a <var class="term">uniNal</var> item by its position (item number) in the <var>UnicodeNamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">uniNal</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr>
</table>
</table>
==Usage notes==
<ul><li>If the <var>NameByNumber</var> property is being retrieved and there is no item on the <var>UnicodeNamedArraylist</var> that has the indicated item number, the result is one of the following actions:
<ul><li>The request is cancelled if the <var>[[UseDefault (UnicodeNamedArraylist property)|UseDefault]]</var> property value is <var class="code">False</var>.
<li>The <var>[[Default (UnicodeNamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <var class="code">True</var>.
</ul></ul>


==Examples==
==Examples==
<ol><li>For an example using <var>NameByNumber</var>, see [[UnicodeNamedArraylist class|"UnicodeNamedArraylist class"]].</ol>
For an example using <var>NameByNumber</var>, see [[UnicodeNamedArraylist class|"UnicodeNamedArraylist class"]].


==See also==
==See also==
<ul><li><var>[[Number (UnicodeNamedArraylist property)|Number]]</var> lets you retrieve an item's content using its item number.</ul>
<ul>
<li><var>[[Number (UnicodeNamedArraylist function)|Number]]</var> lets you retrieve an item's ordinal number using its item name.
<li><var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> lets you retrieve or set an item using the item's ordinal number.
</ul>
{{Template:UnicodeNamedArraylist:NameByNumber footer}}
{{Template:UnicodeNamedArraylist:NameByNumber footer}}

Latest revision as of 02:57, 8 August 2012

Name of specified item (UnicodeNamedArraylist class)


NameByNumber returns the subscript name of the item that has the specified item number (position) in the UnicodeNamedArraylist.

Syntax

%name = uniNal:NameByNumber( number)

Syntax terms

%name A Unicode string to contain the subscript name of the specified uniNal item.
uniNal A UnicodeNamedArraylist object.
number A whole number greater than 0 to identify a uniNal item by its position (item number) in the UnicodeNamedArraylist. If number is greater than the number of items in uniNal, or if it is less than or equal to zero, the request is cancelled.

Examples

For an example using NameByNumber, see "UnicodeNamedArraylist class".

See also

  • Number lets you retrieve an item's ordinal number using its item name.
  • ItemByNumber lets you retrieve or set an item using the item's ordinal number.