Add (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Add subtitle}} | {{Template:Stringlist:Add subtitle}} | ||
This callable method adds arbitrary string data to a <var>Stringlist</var>. The <var>Add</var> method accepts one argument and returns a numeric result. | This callable method adds arbitrary string data to a <var>Stringlist</var>. The <var>Add</var> method accepts one argument and returns a numeric result. | ||
==Syntax== | ==Syntax== | ||
{{Template:Stringlist:Add syntax}} | {{Template:Stringlist:Add syntax}} | ||
| Line 14: | Line 14: | ||
<td>A string that is to be added to the <var>Stringlist</var>.</td></tr> | <td>A string that is to be added to the <var>Stringlist</var>.</td></tr> | ||
</table> | </table> | ||
==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 string 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. <var>[[Push (Stringlist function)|Push]]</var> was designed as a convenience for use with <var>[[Pop (Stringlist function)|Pop]]</var>. <var>[[Enqueue (Stringlist function)|Enqueue]]</var> was designed as a convenience for use with <var>[[Dequeue (Stringlist function)|Dequeue]]</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 string 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. <var>[[Push (Stringlist function)|Push]]</var> was designed as a convenience for use with <var>[[Pop (Stringlist function)|Pop]]</var>. <var>[[Enqueue (Stringlist function)|Enqueue]]</var> was designed as a convenience for use with <var>[[Dequeue (Stringlist function)|Dequeue]]</var>. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
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>: | ||
%list is object stringList | <p class="code"><nowiki>%list is object stringList | ||
... | ... | ||
%list = new | %list = new | ||
| Line 30: | Line 30: | ||
</p> | </p> | ||
end for | end for | ||
</ | </nowiki></p> | ||
==See also== | ==See also== | ||
{{Template:Stringlist:Add footer}} | {{Template:Stringlist:Add footer}} | ||
Revision as of 16:15, 28 February 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 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 <p class="code">%data = ssn with ',' with lname with ',' - fname with ',' with mi %list:add(%data) </p> end for