Add (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Remove attibute from closing tag(s)) |
||
| 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 string has been added. <var class="term">%number</var | <td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the string has been added. <var class="term">%number</var> is also the item number associated with the 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> | ||
| Line 16: | Line 16: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors result in request cancellation.<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request cancelling error to try to add a longstring longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class="product">Sirius Mods</var | <ul><li>All errors result in request cancellation.<li>Before <var class="product">Sirius Mods</var> Version 6.6, it was a request cancelling error to try to add a longstring longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class="product">Sirius Mods</var> Version 6.6.<li>The <var>[[Push (Stringlist function)|Push]]</var> and <var>[[Enqueue (Stringlist function)|Enqueue]]</var> stringlist methods are the same as the <var>Add</var> method. Push was designed as a convenience for use with <var>[[Pop (Stringlist function)|Pop]]</var>. <var>Enqueue</var> was designed as a convenience for use with <var>[[Dequeue (Stringlist function)|Dequeue]]</var>. | ||
</ul> | </ul> | ||
Revision as of 07:47, 25 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.
Syntax
[%number =] sl:Add( itemList)
Syntax terms
| %number | A numeric variable to contain the number of items in the indicated Stringlist after the string has been added. %number 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 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