RemoveItem (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax diagram to template and fix tags) |
||
| Line 2: | Line 2: | ||
This callable method removes a specified item from the <var>Arraylist</var>. | This callable method removes a specified item from the <var>Arraylist</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:RemoveItem syntax}} | {{Template:Arraylist:RemoveItem syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>% | <tr><th><i>%count</i></th> | ||
<td> | <td>An, optional, numeric variable to contain the number of items in the <var>Arraylist</var> after the specified item is removed. </td></tr> | ||
<tr><th><i><var class="term">al</var></i></th> | <tr><th><i><var class="term">al</var></i></th> | ||
<td>An <var>Arraylist</var> object. </td></tr> | <td>An <var>Arraylist</var> object. </td></tr> | ||
<tr><th><i>number</i></th> | <tr><th><i>number</i></th> | ||
<td>A whole number greater than 0 to identify an | <td>A whole number greater than 0 to identify an <var class="term">al</var> item. If <var class="term">number</var> is greater than the number of items in the <var class="term">al</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr> | ||
</table> | </table> | ||
==See also== | ==See also== | ||
{{Template:Arraylist:RemoveItem footer}} | {{Template:Arraylist:RemoveItem footer}} | ||
Revision as of 05:58, 30 January 2011
Remove item from Arraylist (Arraylist class)
This callable method removes a specified item from the Arraylist.
Syntax
[%count =] al:RemoveItem( number)
Syntax terms
| %count | An, optional, numeric variable to contain the number of items in the Arraylist after the specified item is removed. |
|---|---|
| al | An Arraylist object. |
| number | A whole number greater than 0 to identify an al item. If number is greater than the number of items in the al, or if it is less than or equal to zero, the request is cancelled. |