Add (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{Template:Stringlist:Add subtitle}} | |||
This callable method adds arbitrary string data to a Stringlist. The Add method accepts one argument and returns a numeric result. | This callable method adds arbitrary string data to a Stringlist. The Add method accepts one argument and returns a numeric result. | ||
| Line 5: | Line 5: | ||
Add is a member of the [[Stringlist class]]. | Add is a member of the [[Stringlist class]]. | ||
== | ==Syntax== | ||
{{Template:Stringlist:Add syntax}} | |||
===Syntax terms=== | |||
===Syntax | |||
<dl> | <dl> | ||
<dt>%rc<dd>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.<dt>%sl<dd>A Stringlist object.<dt>string<dd>A string that is to be added to the Stringlist. </dl> | <dt>%rc<dd>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.<dt>%sl<dd>A Stringlist object.<dt>string<dd>A string that is to be added to the Stringlist. </dl> | ||
==Usage notes== | |||
<ul><li>All errors result in request cancellation.<li>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.<li>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)]]. | <ul><li>All errors result in request cancellation.<li>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.<li>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)]]. | ||
</ul> | </ul> | ||
==Examples== | |||
In the following example, four comma-delimited field values are added to a Stringlist for each record in a Recordset:<pre> | In the following example, four comma-delimited field values are added to a Stringlist for each record in a Recordset:<pre> | ||
%list is object stringList | %list is object stringList | ||
Revision as of 04:59, 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