Number (NamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:NamedArraylist:Number subtitle}} | {{Template:NamedArraylist:Number subtitle}} | ||
<var>Number</var> returns the item number (ordinal) of the item that has the specified name in the <var>NamedArraylist</var>. | |||
specified name in the NamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:Number syntax}} | {{Template:NamedArraylist:Number syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable to contain the number of the named | <td>A numeric variable to contain the number of the named <var class="term">nal</var> item. </td></tr> | ||
<tr><th> | <tr><th>nal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>NamedArraylist</var> object. </td></tr> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>A string that serves as a subscript to identify a | <td>A string that serves as a subscript to identify a <var class="term">nal</var> item. If the indicated name is not in <var class="term">nal</var>, <var class="output">0</var> is returned, regardless of the setting of <var>[[UseDefault (NamedArraylist property)|UseDefault]]</var>.</td></tr> | ||
</table> | </table> | ||
== | |||
==See also== | |||
<ul> | <ul> | ||
<li> | <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 (NamedArraylist function)|NameByNumber]]</var> function lets you retrieve an item's name using the item's ordinal number. | |||
</ul> | </ul> | ||
{{Template:NamedArraylist:Number footer}} | {{Template:NamedArraylist:Number footer}} | ||
Latest revision as of 22:14, 7 August 2012
Item number of specified name (NamedArraylist class)
Number returns the item number (ordinal) of the item that has the specified name in the NamedArraylist.
Syntax
%number = nal:Number( name)
Syntax terms
| %number | A numeric variable to contain the number of the named nal item. |
|---|---|
| nal | A NamedArraylist object. |
| name | A string that serves as a subscript to identify a nal item. If the indicated name is not in nal, 0 is returned, regardless of the setting of UseDefault. |
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.