Number (UnicodeNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→See also) |
|||
(8 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Template:UnicodeNamedArraylist:Number subtitle}} | {{Template:UnicodeNamedArraylist:Number subtitle}} | ||
<var>Number</var> returns the item number (ordinal) of the item that has the specified subscript name in the <var>UnicodeNamedArraylist</var>. | |||
specified subscript name in the UnicodeNamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:UnicodeNamedArraylist:Number syntax}} | {{Template:UnicodeNamedArraylist:Number syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%number</th> | ||
< | <td>A numeric variable to contain the item number of the specified <var class="term">uniNal</var> item. </td></tr> | ||
specified | <tr><th>uniNal</th> | ||
< | <td>A <var>UnicodeNamedArraylist</var> object. </td></tr> | ||
< | <tr><th>name</th> | ||
< | <td>A Unicode string that serves as a subscript name to identify a <var class="term">uniNal</var> item.</td></tr> | ||
< | </table> | ||
that serves as a subscript name to identify a | |||
==Usage notes== | ==Usage notes== | ||
<ul><li>If <var>Number</var> is called and there is no item on the <var>UnicodeNamedArraylist</var> that has the indicated subscript, a <var class="output">0</var> is returned, regardless of the setting of <var>[[UseDefault (UnicodeNamedArraylist property)|UseDefault]]</var>. | |||
</ul> | |||
==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 (UnicodeNamedArraylist function)|NameByNumber]]</var> function lets you retrieve an item's name using the item's ordinal number. | |||
</ul> | </ul> | ||
{{Template:UnicodeNamedArraylist:Number footer}} | {{Template:UnicodeNamedArraylist:Number footer}} |
Latest revision as of 19:19, 21 July 2011
Item number of specified name (UnicodeNamedArraylist class)
Number returns the item number (ordinal) of the item that has the specified subscript name in the UnicodeNamedArraylist.
Syntax
%number = uniNal:Number( name)
Syntax terms
%number | A numeric variable to contain the item number of the specified uniNal item. |
---|---|
uniNal | A UnicodeNamedArraylist object. |
name | A Unicode string that serves as a subscript name to identify a uniNal item. |
Usage notes
- If Number is called and there is no item on the UnicodeNamedArraylist that has the indicated subscript, a 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.