RemoveItem (UnicodeNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 6: Line 6:
{{Template:UnicodeNamedArraylist:RemoveItem syntax}}
{{Template:UnicodeNamedArraylist:RemoveItem syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%num</i>
<tr><th><i>%num</i></th>
<dd>A numeric variable to contain the number of items in the UnicodeNamedArraylist
<td>A numeric variable to contain the number of items in the UnicodeNamedArraylist after the specified item is removed. </td></tr>
after the specified item is removed.
<tr><th><i>%unamrayl</i></th>
<dt><i>%unamrayl</i>
<td>A UnicodeNamedArraylist object. </td></tr>
<dd>A UnicodeNamedArraylist object.
<tr><th><i>name</i></th>
<dt><i>name</i>
<td>A Unicode string that serves as a subscript name to identify a ''%unamrayl'' item.
<dd>A Unicode string
If no item in ''%unamrayl'' has the specified subscript, the request is cancelled, regardless of the setting of [[UseDefault (UnicodeNamedArraylist property)|UseDefault]].</td></tr>
that serves as a subscript name to identify a ''%unamrayl'' item.
</table>
 
If no item in ''%unamrayl'' has the specified subscript,
the request is cancelled,
regardless of the setting of [[UseDefault (UnicodeNamedArraylist property)|UseDefault]].
 
</dl>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 23:09, 31 January 2011

Remove item from UnicodeNamedArraylist (UnicodeNamedArraylist class)


This callable function removes from the UnicodeNamedArraylist the item that has the specified subscript name.

Syntax

[%count =] uniNal:RemoveItem( unicode)

Syntax terms

%num A numeric variable to contain the number of items in the UnicodeNamedArraylist after the specified item is removed.
%unamrayl A UnicodeNamedArraylist object.
name A Unicode string that serves as a subscript name to identify a %unamrayl item. If no item in %unamrayl has the specified subscript, the request is cancelled, regardless of the setting of UseDefault.

Usage notes

See also