Insert (Arraylist function)

From m204wiki
Revision as of 01:47, 2 February 2011 by Goff (talk | contribs) (review and edit for better wording)
Jump to navigation Jump to search

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