Enqueue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<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 <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> | <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 <var>Stringlist</var> object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> |
Revision as of 15:49, 19 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 Enqueue method accepts one argument and returns a numeric result.
Syntax
[%count =] sl:Enqueue( 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 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 Add method (Add (Stringlist function)) and the Enqueue method are the same. Enqueue was designed as a convenience for use with the Dequeue (Stringlist function).