RemoveItem (NamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 13: Line 13:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%num</i></th>
<tr><th>%num</th>
<td>A numeric variable to contain the number of items in the NamedArraylist after the specified item is removed. </td></tr>
<td>A numeric variable to contain the number of items in the NamedArraylist after the specified item is removed. </td></tr>
<tr><th><i>%namrayl</i></th>
<tr><th>%namrayl</th>
<td>A NamedArraylist object. </td></tr>
<td>A NamedArraylist object. </td></tr>
<tr><th><i>name</i></th>
<tr><th>name</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 ''%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>
  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>

Revision as of 17:28, 4 February 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.