NameByNumber (FloatNamedArraylist function)

From m204wiki
Revision as of 18:17, 5 January 2011 by Admin (talk | contribs) (1 revision)
Jump to navigation Jump to search

<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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=NameByNumber_(FloatNamedArraylist_function)&oldid=15763"