Number (FloatNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to diagram, tags and edits (will need to be redone when syntax template is fixed)) |
|||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:FloatNamedArraylist:Number subtitle}} | {{Template:FloatNamedArraylist:Number subtitle}} | ||
<var>Number</var> returns the item number (ordinal) of the item that has the specified subscript in the <var>FloatNamedArraylist</var>. | |||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable to contain the item number of the | <td>A numeric variable to contain the item number of the <var class="term">fltNal</var> item selected by <var class="term">subscript</var>.</td></tr> | ||
<tr><th>fltNal</th> | <tr><th>fltNal</th> | ||
<td>A <var>FloatNamedArraylist</var> object. </td></tr> | <td>A <var>FloatNamedArraylist</var> object. </td></tr> | ||
<tr><th> | <tr><th>subscript</th> | ||
<td>A numeric value that serves as a subscript to identify a <var class="term">fltNal</var> item.</td></tr> | <td>A numeric value that serves as a subscript to identify a <var class="term">fltNal</var> item.</td></tr> | ||
</table> | </table> | ||
| Line 17: | Line 17: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If <var>Number</var> is called and there is no item on the <var>FloatNamedArraylist</var> that has the indicated | <li>If <var>Number</var> is called and there is no item on the <var>FloatNamedArraylist</var> that has the indicated <var class="term">subscript</var>, a <code>0</code> is returned, regardless of the setting of <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var>. | ||
</ul> | </ul> | ||
==Examples== | |||
<p class="code">b | |||
%y is collection floatNamedArraylist of string len 32 | |||
%i is float | |||
%y = new | |||
%y(7) = 'seven' | |||
%y(38) = 'thirty-eight' | |||
%y(110) = 'one-hundred-ten' | |||
%i = 38 | |||
print %y:number(%y:nameByNumber(%i)) and %y:nameByNumber(%i) and %y:itemByNumber(%i) | |||
end for | |||
end | |||
</p> | |||
The request prints: | |||
<p class="output"> | |||
2 38 thirty-eight | |||
</p> | |||
==See also== | ==See also== | ||
<ul> | |||
<li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> property lets you retrieve or set an item using the item's ordinal number. | |||
<li>The <var>[[NameByNumber (FloatNamedArraylist function)|NameByNumber]]</var> function lets you retrieve an item's name using the item's ordinal number. | |||
</ul> | |||
{{Template:FloatNamedArraylist:Number footer}} | {{Template:FloatNamedArraylist:Number footer}} | ||
Latest revision as of 15:22, 23 September 2020
Item number of specified name (FloatNamedArraylist class)
Number returns the item number (ordinal) of the item that has the specified subscript in the FloatNamedArraylist.
Syntax
%number = fltNal:Number( subscript)
Syntax terms
| %number | A numeric variable to contain the item number of the fltNal item selected by subscript. |
|---|---|
| fltNal | A FloatNamedArraylist object. |
| subscript | A numeric value that serves as a subscript to identify a fltNal item. |
Usage notes
- If Number is called and there is no item on the FloatNamedArraylist that has the indicated subscript, a
0is returned, regardless of the setting of UseDefault.
Examples
b %y is collection floatNamedArraylist of string len 32 %i is float %y = new %y(7) = 'seven' %y(38) = 'thirty-eight' %y(110) = 'one-hundred-ten' %i = 38 print %y:number(%y:nameByNumber(%i)) and %y:nameByNumber(%i) and %y:itemByNumber(%i) end for end
The request prints:
2 38 thirty-eight
See also
- The ItemByNumber property lets you retrieve or set an item using the item's ordinal number.
- The NameByNumber function lets you retrieve an item's name using the item's ordinal number.