NameByNumber (FloatNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (little more)
m (update syntax terms to match corrected template)
Line 7: Line 7:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%number</th>
<tr><th>%subscript</th>
<td>A numeric variable to contain the subscript of the specified <var class="term">fltNal</var> item. </td></tr>
<td>A numeric variable to contain the subscript of the specified <var class="term">fltNal</var> item. </td></tr>
<tr><th>fltNal</th>
<tr><th>fltNal</th>
Line 16: Line 16:


==Usage notes==
==Usage notes==
<ul><li>If the <var>NameByNumber</var> property is being retrieved and there is no item on the </var>FloatNamedArraylist</var> that has the indicated item number, the result is one of the following actions:
<ul><li>If the <var>NameByNumber</var> property is being retrieved and there is no item on the <var>FloatNamedArraylist</var> that has the indicated item number, the result is one of the following actions:
<ul><li>The request is cancelled if the <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var> property value is <var class="code">False</var>.
<ul><li>The request is cancelled if the <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var> property value is <var class="code">False</var>.
<li>The <var>[[Default (FloatNamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <var class="code">True</var>.
<li>The <var>[[Default (FloatNamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <var class="code">True</var>.

Revision as of 04:03, 11 March 2011

Name of specified item number (FloatNamedArraylist class)


The NameByNumber ReadOnly property returns the "name" (in this case a numerical subscript) of the item that has the specified item number (position) in the FloatNamedArraylist.

Syntax

%subscript = fltNal:NameByNumber( number)

Syntax terms

%subscript A numeric variable to contain the subscript of the specified fltNal item.
fltNal A FloatNamedArraylist object.
number A whole number greater than 0 to identify a fltNal item by its position (item number) in the numerically ordered FloatNamedArraylist. If number is greater than the number of items in fltNal, 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.

See also

  • Number lets you retrieve an item's content using its item number.