NameByNumber (UnicodeNamedArraylist function)

From m204wiki
Revision as of 19:14, 21 July 2011 by JAL2 (talk | contribs) (→‎See also)
Jump to navigation Jump to search

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.

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.

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.