NameByNumber (UnicodeNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 7: Line 7:
{{Template:UnicodeNamedArraylist:NameByNumber syntax}}
{{Template:UnicodeNamedArraylist:NameByNumber syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>name</i>
<tr><th><i>name</i></th>
<dd>A Unicode string to contain the subscript name of the
<td>A Unicode string to contain the subscript name of the specified ''fnamrayl'' item. </td></tr>
specified ''fnamrayl'' item.
<tr><th><i>%unamrayl</i></th>
<dt><i>%unamrayl</i>
<td>A UnicodeNamedArraylist object. </td></tr>
<dd>A UnicodeNamedArraylist object.
<tr><th><i>number</i></th>
<dt><i>number</i>
<td>A whole number greater than 0 to identify a ''%unamrayl'' item by its position (item number) in the UnicodeNamedArraylist. If ''number'' is greater than the number of items in ''%unamrayl'', or if it is less than or equal to zero, the request is cancelled.</td></tr>
<dd>A whole number greater than 0 to identify a ''%unamrayl'' item
</table>
by its position (item number) in the UnicodeNamedArraylist.
If ''number'' is greater than the number of items in ''%unamrayl'',
or if it is less than or equal to zero, the request is cancelled.
 
</dl>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 23:09, 31 January 2011

Name of specified item (UnicodeNamedArraylist class)


This ReadOnly property 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 fnamrayl item.
%unamrayl A UnicodeNamedArraylist object.
number A whole number greater than 0 to identify a %unamrayl item by its position (item number) in the UnicodeNamedArraylist. If number is greater than the number of items in %unamrayl, or if it is less than or equal to zero, the request is cancelled.

Usage notes

  • If the NameByNumber property is being retrieved and there is no item on the UnicodeNamedArraylist that has the indicated item number, the result is one of the following actions:
    • The request is cancelled if the UseDefault property value is False.
    • The Default value is returned if the UseDefault property is True.
  • Number lets you retrieve an item's content using its item number.
  • For an example using the NameByNumber method, see UnicodeNamedArraylist class.

See also