RemoveItem (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:RemoveItem(name) | <p class="code">[%num =] %namrayl:RemoveItem(name) | ||
</p> | </p> | ||
===Syntax | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th><i>%num</i></th> | ||
< | <td>A numeric variable to contain the number of items in the NamedArraylist after the specified item is removed. </td></tr> | ||
after the specified item is removed. | <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 no item in ''%namrayl'' has the specified subscript name, the request is cancelled, regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]].</td></tr> | ||
</table> | |||
If no item in ''%namrayl'' has the specified subscript name, | |||
the request is cancelled, | |||
regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]]. | |||
</ | |||
Revision as of 23:08, 31 January 2011
<section begin=dpl_desc/>Remove item from NamedArraylist<section end=dpl_desc/>
RemoveItem is a member of the NamedArraylist class.
This callable function removes from the NamedArraylist the item that has the specified subscript name.
Syntax
[%num =] %namrayl:RemoveItem(name)
Syntax terms
| %num | A numeric variable to contain the number of items in the NamedArraylist after the specified item is removed. |
|---|---|
| %namrayl | A NamedArraylist object. |
| name | A string that serves as a subscript to identify a %namrayl item. If no item in %namrayl has the specified subscript name, the request is cancelled, regardless of the setting of UseDefault. |