Add (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
Line 8: | Line 8: | ||
{{Template:Stringlist:Add syntax}} | {{Template:Stringlist:Add syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%rc</th> | ||
<td>A numeric variable to contain the number of items in the indicated Stringlist after the string has been added. '''%rc''' is also the item number associated with the added string in the Stringlist.</td></tr> | |||
<tr><th>sl</th> | |||
<td>A Stringlist object.</td></tr> | |||
<tr><th>string</th> | |||
<td>A string that is to be added to the Stringlist.</td></tr> | |||
</table> | |||
==Usage notes== | ==Usage notes== |
Revision as of 20:00, 16 January 2011
Add strings to Stringlist (Stringlist class)
This callable method adds arbitrary string data to a Stringlist. The Add method accepts one argument and returns a numeric result.
Add is a member of the Stringlist class.
Syntax
[%number =] sl:Add( itemList)
Syntax terms
%rc | A numeric variable to contain the number of items in the indicated Stringlist after the string has been added. %rc is also the item number associated with the added string in the Stringlist. |
---|---|
sl | A Stringlist object. |
string | A 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 longstring longer than the size limit of a Stringlist item: 6124 bytes. This limitation was eliminated in Sirius Mods Version 6.6.
- The Push (Stringlist function) and Enqueue (Stringlist function) are the same as the Add method. Push was designed as a convenience for use with Pop (Stringlist function). Enqueue was designed as a convenience for use with Dequeue (Stringlist function).
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