RemoveItem (UnicodeNamedArraylist function): Difference between revisions

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


This callable function removes from the UnicodeNamedArraylist
the item that has the specified subscript name.
==Syntax==
==Syntax==
  [%num =] %unamrayl:RemoveItem(name)
{{Template:UnicodeNamedArraylist:RemoveItem syntax}}
===Syntax Terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%num</i>
<tr><th>%count</th>
<dd>A numeric variable to contain the number of items in the UnicodeNamedArraylist
<td>An, optional, numeric variable to contain the number of items remaining in the <var>UnicodeNamedArraylist</var> after the specified item is removed.</td></tr>
after the specified item is removed.
<tr><th>uniNal</th>
<dt><i>%unamrayl</i>
<td>A <var>UnicodeNamedArraylist</var> object. </td></tr>
<dd>A UnicodeNamedArraylist object.
<tr><th>unicode</th>
<dt><i>name</i>
<td>A Unicode string that serves as a subscript name to identify a <var class="term">uniNal</var> item.</td></tr>
<dd>A Unicode string
</table>
that serves as a subscript name to identify a ''%unamrayl'' item.
 
==Usage notes==
<ul><li>If <var>RemoveItem</var> cannot find an item in the <var>UnicodeNamedArraylist</var> with the specified subscript name, the request is cancelled, regardless of the setting of <var>[[UseDefault (UnicodeNamedArraylist property)|UseDefault]]</var>.
</ul>


If no item in ''%unamrayl'' has the specified subscript,
==Examples==
the request is cancelled,
For an example using <var>RemoveItem</var>, see [[UnicodeNamedArraylist class|"UnicodeNamedArraylist class"]].
regardless of the setting of [[UseDefault (UnicodeNamedArraylist property)|UseDefault]].


</dl>
==See also==
==Usage Notes==
{{Template:UnicodeNamedArraylist:RemoveItem footer}}
<ul>
<li>For an example using the RemoveItem method, see [[UnicodeNamedArraylist class]].
</ul>

Latest revision as of 20:38, 1 November 2012

Remove item from UnicodeNamedArraylist (UnicodeNamedArraylist class)


RemoveItem removes the item, that has the specified subscript name, from the UnicodeNamedArraylist.

Syntax

[%count =] uniNal:RemoveItem( unicode)

Syntax terms

%count An, optional, numeric variable to contain the number of items remaining in the UnicodeNamedArraylist after the specified item is removed.
uniNal A UnicodeNamedArraylist object.
unicode A Unicode string that serves as a subscript name to identify a uniNal item.

Usage notes

  • If RemoveItem cannot find an item in the UnicodeNamedArraylist with the specified subscript name, the request is cancelled, regardless of the setting of UseDefault.

Examples

For an example using RemoveItem, see "UnicodeNamedArraylist class".

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=RemoveItem_(UnicodeNamedArraylist_function)&oldid=16023"