Add (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 22: Line 22:
   
   
==Examples==
==Examples==
===Adding a single item to a Stringlist===
In the following example, four comma-delimited field values are added to a <var>Stringlist</var> for each record in a <var>Recordset</var>:
In the following example, four comma-delimited field values are added to a <var>Stringlist</var> for each record in a <var>Recordset</var>:
<p class="code">%list is object stringList
<p class="code">%list is object stringList
Line 32: Line 34:
end for
end for
</p>
</p>
   
 
===Adding multiple items to a Stringlist===
 
In the following example, a string literal, the contents of a variable, and the contents of another <var>Stringlist</var> are added to a <var>Stringlist</var>:
<p class="code">b
%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
</p>
 
This outputs:
<p class="output">John
Michael
Eric
Terry
Graham
Moe
Larry
Curly
</p>
 
==See also==
==See also==
{{Template:Stringlist:Add footer}}
{{Template:Stringlist:Add footer}}

Revision as of 03:13, 14 March 2011

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.
string 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 beStringlists, in which case each item in the input Stringlist is added to the targetStringlist. 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.
  • Before Sirius Mods Version 6.6, it was a request cancelling error to try to add a string longer than the size limit of a Stringlist item: 6124 bytes. This limitation was eliminated in Sirius Mods Version 6.6.
  • The Push and Enqueue stringlist methods are the same as the Add method. 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:

b %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