NameByNumber (NamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
item number in the NamedArraylist. | item number in the NamedArraylist. | ||
==Syntax== | ==Syntax== | ||
<p class="code">%name = %namrayl:NameByNumber(number) | |||
</p> | |||
===Syntax Terms=== | ===Syntax Terms=== | ||
<dl> | <dl> | ||
Revision as of 20:55, 28 January 2011
<section begin=dpl_desc/>Name of specified item<section end=dpl_desc/>
NameByNumber is a member of the NamedArraylist class.
This ReadOnly property returns the name of the item that has the indicated item number in the NamedArraylist.
Syntax
%name = %namrayl:NameByNumber(number)
Syntax Terms
- %name
- A string variable to contain the name of the namrayl item that is specified by number.
- %namrayl
- A NamedArraylist object.
- number
- A whole number greater than 0 to identify a %namrayl item by its position (item number) in the alphabetically ordered NamedArraylist. If number is greater than the number of items in %namrayl, 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
NamedArraylist that 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 (NamedArraylist property)|Default]] value is returned if the UseDefault property is True.
- The Number property lets you retrieve an item using its item number.