NameByNumber (FloatNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 14: | Line 14: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%subscript</th> | ||
<td>A numeric variable to contain the subscript of the specified ''fnamrayl'' item. </td></tr> | <td>A numeric variable to contain the subscript of the specified ''fnamrayl'' item. </td></tr> | ||
<tr><th | <tr><th>%fnamrayl</th> | ||
<td>A FloatNamedArraylist object. </td></tr> | <td>A FloatNamedArraylist object. </td></tr> | ||
<tr><th | <tr><th>number</th> | ||
<td>A whole number greater than 0 to identify a ''%fnamrayl'' item by its position (item number) in the numerically ordered FloatNamedArraylist. If ''number'' is greater than the number of items in ''%fnamrayl'', 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 ''%fnamrayl'' item by its position (item number) in the numerically ordered FloatNamedArraylist. If ''number'' is greater than the number of items in ''%fnamrayl'', or if it is less than or equal to zero, the request is cancelled.</td></tr> | ||
</table> | </table> | ||
Revision as of 17:28, 4 February 2011
<section begin=dpl_desc/>Subscript of specified item<section end=dpl_desc/>
NameByNumber is a member of the FloatNamedArraylist class.
This ReadOnly property returns the “name” (numerical subscript) of the item that has the specified item number (position) in the FloatNamedArraylist.
Syntax
%subscript = %fnamrayl:NameByNumber(number)
Syntax terms
| %subscript | A numeric variable to contain the subscript of the specified fnamrayl item. |
|---|---|
| %fnamrayl | A FloatNamedArraylist object. |
| number | A whole number greater than 0 to identify a %fnamrayl item by its position (item number) in the numerically ordered FloatNamedArraylist. If number is greater than the number of items in %fnamrayl, 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
FloatNamedArraylist 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.