Add (Stringlist function)

From m204wiki
Revision as of 15:01, 10 October 2012 by JAL (talk | contribs) (→‎Syntax terms)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Add strings to Stringlist (Stringlist class)

This callable method adds arbitrary string data to a Stringlist. The Add method accepts one or more arguments and returns a numeric result.

Syntax

[%number =] sl:Add( itemList)

Syntax terms

%number A numeric variable to contain the number of items in the indicated Stringlist after the strings have been added. %number is also the item number associated with the last added string in the Stringlist.
sl A Stringlist object.
itemList Under Sirius Mods 7.9 and later, this is a comma-delimited set of strings, each of which, from left to right, is added to the method object Stringlist. The items in the list could themselves be Stringlists, in which case each item in the input Stringlist is added to the target Stringlist. Under Sirius Mods 7.8 and earlier, itemList could only be a single string that is to be added to the Stringlist.

Usage notes

  • All errors result in request cancellation.
  • The Push and Enqueue stringlist methods are the same as the Add method with the exception that (under Sirius Mods 7.9 and later) Add can add more than one item to the method object Stringlist whereas Push and Enqueue can only add one. Push was designed as a convenience for use with Pop. Enqueue was designed as a convenience for use with Dequeue.

Examples

Adding a single item to a Stringlist

In the following example, four comma-delimited field values are added to a Stringlist for each record in a Recordset:

%list is object stringList ... %list = new for each record in %recset %data = ssn with ',' with lname with ',' - fname with ',' with mi %list:add(%data) end for

Adding multiple items to a Stringlist

In the following example, a string literal, the contents of a variable, and the contents of another Stringlist are added to a Stringlist:

begin %sl is object stringlist %python is string len 32 %stooges is object stringlist %stooges = list('Moe', 'Larry', 'Curly') %sl = list('John', 'Michael', 'Eric') %python = 'Graham' %sl:add('Terry', %python, %stooges) %sl:print end

This outputs:

John Michael Eric Terry Graham Moe Larry Curly

See also