Number (NamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 11: | Line 11: | ||
<p class="code">%num = %namrayl:Number(name) | <p class="code">%num = %namrayl:Number(name) | ||
</p> | </p> | ||
===Syntax | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th><i>%num</i></th> | ||
< | <td>A numeric variable to contain the number of the named ''%namrayl'' item. </td></tr> | ||
< | <tr><th><i>%namrayl</i></th> | ||
< | <td>A NamedArraylist object. </td></tr> | ||
< | <tr><th><i>name</i></th> | ||
< | <td>A string that serves as a subscript to identify a ''%namrayl'' item. If the indicated name is not in ''%namrayl'', <tt>0</tt> is returned, regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]].</td></tr> | ||
If the indicated name is not in ''%namrayl'', <tt>0</tt> is returned, | </table> | ||
regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]]. | |||
</ | |||
==Usage Notes== | ==Usage Notes== | ||
<ul> | <ul> | ||
Revision as of 23:08, 31 January 2011
<section begin=dpl_desc/>Item number of named item<section end=dpl_desc/>
Number is a member of the NamedArraylist class.
This ReadOnly property returns the item number (ordinal) of the item that has the specified name in the NamedArraylist.
Syntax
%num = %namrayl:Number(name)
Syntax terms
| %num | A numeric variable to contain the number of the named %namrayl item. |
|---|---|
| %namrayl | A NamedArraylist object. |
| name | A string that serves as a subscript to identify a %namrayl item. If the indicated name is not in %namrayl, 0 is returned, regardless of the setting of UseDefault. |
Usage Notes
- If the Number property is called and there is no item on the NamedArraylist that has the indicated subscript name, a 0 is returned, regardless of the setting of UseDefault.