NameByNumber (NamedArraylist function)

From m204wiki
Revision as of 19:36, 21 July 2011 by JAL2 (talk | contribs)
Jump to navigation Jump to search

Name of specified item number (NamedArraylist class)


NameByNumber returns the name of the item that has the indicated item number in the NamedArraylist.

Syntax

%name = nal:NameByNumber( number)

Syntax terms

%name A string variable to contain the name of the nal item that is specified by number.
nal A NamedArraylist object.
number A whole number greater than 0 to identify a nal item by its position (item number) in the alphabetically ordered NamedArraylist. If number is greater than the number of items in nal, 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 NamedArraylistthat has the indicated item number, the result is one of the following actions:
    • The request is cancelled if the UseDefault property is False.
    • The Default value is returned if the UseDefault property is True.

See also

  • Number lets you retrieve an item using its item number.