Add (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Add subtitle}} | {{Template:Stringlist:Add subtitle}} | ||
This [[Notation conventions for methods#Callable methods|callable]] method adds arbitrary string data to a <var>Stringlist</var>. The <var>Add</var> method accepts one | This [[Notation conventions for methods#Callable methods|callable]] method adds arbitrary string data to a <var>Stringlist</var>. The <var>Add</var> method accepts one or more arguments and returns a numeric result. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the | <td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the strings have been added. <var class="term">%number</var> is also the item number associated with the last added string in the <var>Stringlist</var>.</td></tr> | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A <var>Stringlist</var> object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td> | <td>Under <var class="product">Sirius Mods</var> 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 <var>Stringlist</var>. The items in the list could themselves be<var>Stringlists</var>, in which case each item in the input <var>Stringlist</var> is added to the target<var>Stringlist</var>. | ||
Under <var class="product">Sirius Mods</var> 7.8 and earlier, <var class="term">itemList</var> could only be a single string that is to be added to the <var>Stringlist</var>.</td></tr> | |||
</table> | </table> | ||
Revision as of 03:06, 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.
|
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
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