Push (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Push subtitle}} | {{Template:Stringlist:Push subtitle}} | ||
This callable method adds arbitrary string data to the end of a <var>Stringlist</var>. | This [[Notation conventions for methods#Callable functions|callable]] method adds arbitrary string data to the end of a <var>Stringlist</var>. <var>Push</var> method accepts one argument and returns a numeric result. | ||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%count</th> | ||
<td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the string has been added. | <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">%count</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> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string that is to be added to the <var>Stringlist</var>.</td></tr> | <td>A <var class="term">string</var> that is to be added to the <var>Stringlist</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All errors result in request cancellation. | <li>All errors result in request cancellation.<li> Available in <var class="product">Sirius Mods</var> version 7.0 and later,</ul> | ||
<li> | |||
</ul> | |||
==See also== | ==See also== | ||
<ul><li>The <var>[[Add (Stringlist function)|Add]]</var> is the same as the <var>Push</var> method; <var>Push</var> was designed as a convenience for use with <var>[[Pop (Stringlist function)|Pop]]</var>.</ul> | |||
{{Template:Stringlist:Push footer}} | {{Template:Stringlist:Push footer}} | ||
Latest revision as of 19:40, 14 July 2011
Add string as new Stringlist item (Stringlist class)
This callable method adds arbitrary string data to the end of a Stringlist. Push method accepts one argument and returns a numeric result.
Syntax
[%count =] sl:Push( string)
Syntax terms
| %count | A numeric variable to contain the number of items in the indicated Stringlist after the string has been added. %count 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.
- Available in Sirius Mods version 7.0 and later,