RemoveItem (UnicodeNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Examples) |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:UnicodeNamedArraylist:RemoveItem subtitle}} | {{Template:UnicodeNamedArraylist:RemoveItem subtitle}} | ||
<var>RemoveItem</var> removes the item, that has the specified subscript name, from the <var>UnicodeNamedArraylist</var>. | |||
the item that has the specified subscript name. | |||
==Syntax== | ==Syntax== | ||
{{Template:UnicodeNamedArraylist:RemoveItem syntax}} | {{Template:UnicodeNamedArraylist: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 items remaining in the <var>UnicodeNamedArraylist</var> after the specified item is removed.</td></tr> | ||
<tr><th> | <tr><th>uniNal</th> | ||
<td>A UnicodeNamedArraylist object. </td></tr> | <td>A <var>UnicodeNamedArraylist</var> object. </td></tr> | ||
<tr><th> | <tr><th>unicode</th> | ||
<td>A Unicode string that serves as a subscript name to identify a | <td>A Unicode string that serves as a subscript name to identify a <var class="term">uniNal</var> item.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <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>. | ||
<li> | |||
</ul> | </ul> | ||
==Examples== | |||
For an example using <var>RemoveItem</var>, see [[UnicodeNamedArraylist class|"UnicodeNamedArraylist class"]]. | |||
==See also== | ==See also== | ||
{{Template:UnicodeNamedArraylist:RemoveItem footer}} | {{Template:UnicodeNamedArraylist:RemoveItem footer}} | ||
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".