RemoveItem (NamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (update syntax terms to match corrected template)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Remove item from NamedArraylist<section end=dpl_desc/></b></span>
{{Template:NamedArraylist:RemoveItem subtitle}}
[[Category:NamedArraylist methods|RemoveItem function]]
 
<!--DPL?? Category:NamedArraylist methods|RemoveItem function: Remove item from NamedArraylist-->
<var>RemoveItem</var> removes the item, that has the specified subscript name, from the <var>NamedArraylist</var>.
<p>
RemoveItem is a member of the [[NamedArraylist class]].
</p>


This callable function removes from the NamedArraylist
the item that has the specified subscript name.
==Syntax==
==Syntax==
<p class="code">[%num =] %namrayl:RemoveItem(name)
{{Template:NamedArraylist:RemoveItem syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%num</i></th>
<tr><th>%count</th>
<td>A numeric variable to contain the number of items in the NamedArraylist after the specified item is removed. </td></tr>
<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><i>%namrayl</i></th>
<tr><th>nal</th>
<td>A NamedArraylist object. </td></tr>
<td>A <var>NamedArraylist</var> object.</td></tr>
<tr><th><i>name</i></th>
<tr><th>string</th>
<td>A string that serves as a subscript to identify a ''%namrayl'' item.
<td>A string that serves as a subscript to identify a <var class="term">nal</var> item to be removed.</td></tr>
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>
</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.

See also