Insert (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to template and fix tags)
m (review and edit for better wording)
Line 13: Line 13:
<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 <var class="term">al</var> item. </td></tr>
<td>A whole number, from 1 to the number of items in <var class="term">al</var> plus one, to identify an <var class="term">al</var> item <b><i>before</i></b> which <var class="term">collectionItem</var> will be inserted.</td></tr>
<tr><th><i>collectionItem</i></th>
<tr><th><i>collectionItem</i></th>
<td>A value or variable of the same type as specified on the <var class="term">al</var> declaration, or a value or variable convertible to that type; to be inserted into <var class="term">al</var>.</td></tr>
<td>A value or variable of the same type as specified on the <var class="term">al</var> declaration, or a value or variable convertible to that type; to be inserted into <var class="term">al</var>.</td></tr>

Revision as of 02:03, 31 January 2011

Insert items into Arraylist (Arraylist class)


This callable function inserts an item before the number item in the Arraylist.

Syntax

[%count =] al:Insert( number, itemList)

Syntax terms

%count An, optional, numeric variable to return the number of items in the indicated Arraylist after the item has been inserted.
al An Arraylist object.
number A whole number, from 1 to the number of items in al plus one, to identify an al item before which collectionItem will be inserted.
collectionItem A value or variable of the same type as specified on the al declaration, or a value or variable convertible to that type; to be inserted into al.

Usage notes

  • If number is less than or equal to the number of items in the Arraylist, the new item is inserted before the indicated item.
  • If number is equal to the number of items in the Arraylist plus one, the new item is added to the end of the Arraylist.
  • If number is greater than the number of items in the Arraylist plus one, or less than or equal to zero, the request is cancelled.
  • For an example using the Insert method, see Arraylist class.

See also