RemoveItem (NamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (update syntax terms to match corrected template) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:NamedArraylist:RemoveItem subtitle}} | |||
<var>RemoveItem</var> removes the item, that has the specified subscript name, from the <var>NamedArraylist</var>. | |||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:RemoveItem syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%count</th> | ||
<td> | <td>An, optional, numeric variable to contain the number of remaining items in the <var>NamedArraylist</var> after the specified item is removed. </td></tr> | ||
<tr><th> | <tr><th>nal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>NamedArraylist</var> object.</td></tr> | ||
<tr><th> | <tr><th>string</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 to be removed.</td></tr> | ||
< | |||
</table> | </table> | ||
==Usage Notes== | |||
<ul><li>If <var>RemoveItem</var> cannot find an item in <var>NamedArraylist</var> with the specified subscript name, the request is cancelled, regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]]. | |||
</ul> | |||
==See also== | |||
{{Template:NamedArraylist:RemoveItem footer}} | |||
Latest revision as of 22:39, 18 March 2011
Remove item from NamedArraylist (NamedArraylist class)
RemoveItem removes the item, that has the specified subscript name, from the NamedArraylist.
Syntax
[%count =] nal:RemoveItem( string)
Syntax terms
| %count | An, optional, numeric variable to contain the number of remaining items in the NamedArraylist after the specified item is removed. |
|---|---|
| nal | A NamedArraylist object. |
| string | A string that serves as a subscript to identify a nal item to be removed. |
Usage Notes
- If RemoveItem cannot find an item in NamedArraylist with the specified subscript name, the request is cancelled, regardless of the setting of UseDefault.