Push (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Push subtitle}} | {{Template:Stringlist:Push subtitle}} | ||
This callable method adds arbitrary string data to the end of a Stringlist. Available in <var class=product>Sirius Mods</var> version 7.0 and later, the Push method accepts one argument and returns a numeric result. | This callable method adds arbitrary string data to the end of a <var>Stringlist</var>. Available in <var class=product>Sirius Mods</var> version 7.0 and later, the Push method accepts one argument and returns a numeric result. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%rc </th> | <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> | <td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the string has been added. '''%rc''' 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 Stringlist object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string that is to be added to the Stringlist.</td></tr> | <td>A string that is to be added to the <var>Stringlist</var>.</td></tr> | ||
</table> | </table> | ||
| Line 18: | Line 18: | ||
<ul> | <ul> | ||
<li>All errors result in request cancellation. | <li>All errors result in request cancellation. | ||
<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request canceling error to try to add a longstring longer than the size limit of a Stringlist item: 6124 bytes. This limitation was eliminated in <var class=product>Sirius Mods</var> Version 6.6. | <li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request canceling 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 [[Add (Stringlist function)]] is the same as the Push method; Push was designed as a convenience for use with the [[Pop (Stringlist function)]]. | <li>The [[Add (Stringlist function)]] is the same as the Push method; Push was designed as a convenience for use with the [[Pop (Stringlist function)]]. | ||
</ul> | </ul> | ||
[[Category:Stringlist methods|Push function]] | [[Category:Stringlist methods|Push function]] | ||
Revision as of 21:33, 18 January 2011
Add string as new Stringlist item (Stringlist class)
This callable method adds arbitrary string data to the end of a Stringlist. Available in Sirius Mods version 7.0 and later, the Push method accepts one argument and returns a numeric result.
Syntax
[%count =] sl:Push( string)
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 canceling 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 Add (Stringlist function) is the same as the Push method; Push was designed as a convenience for use with the Pop (Stringlist function).