Insert (Stringlist function)

Insert string into a Stringlist

This callable method inserts a string into a Stringlist.

Insert is a member of the Stringlist class.

Insert Syntax

[%rc =] %sl:Insert(itemnum, string)

%rc: A numeric variable to contain the number of items in %sl after the string has been inserted.
%sl: A Stringlist object.
itemnum: The item number before which the string is to be inserted. If itemnum is equal to the number of items in the Stringlist plus one, string is added to the end of the Stringlist (the same effect as an Add invocation). Because the string is inserted before the indicated item number, itemnum is also the item number of the new Stringlist item after Insert returns.
string: A string that is to be inserted into the %sl Stringlist.

All errors in Insert result in request cancellation.
Before Sirius Mods Version 6.6, it was a request canceling error to try to insert a longstring longer than the size limit of a Stringlist item: 6124 bytes. This limitation was eliminated in Sirius Mods Version 6.6.
An Insert can result in the splitting of a Stringlist leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent RemoveItem (Stringlist function) invocations make this possible. Because of this splitting, heavy use of Insert and RemoveItem can result in "sparse" Stringlists which place an unnecessary burden on the buffer pool and CCATEMP. To make matters worse, Copy does a page-for-page copy of a Stringlist, so it does not result in any compression of the resultant Stringlist. Stringlist compression can be achieved using the CopyItems (Stringlist function).