Enqueue (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Stringlist:Enqueue subtitle}}
{{Template:Stringlist:Enqueue subtitle}}


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 <var>Enqueue</var> method accepts one argument and returns a numeric result.
This [[Notation conventions for methods#Callable functions|callable]] method adds arbitrary string data to the end of a <var>Stringlist</var>. <var>Enqueue</var> 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>%rc</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. '''%rc''' is also the item number associated with the added string in the <var>Stringlist</var>. </td></tr>
<td>An, optional, 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 newly added <var class="term">string</var> 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 new string that is to be added to the end of <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 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>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request cancelling error to try to add a <var class="term">string</var> 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 method ([[Add (Stringlist function)]]) and the Enqueue method are the same. Enqueue was designed as a convenience for use with the [[Dequeue (Stringlist function)]].</ul>
<li>The <var>[[Add (Stringlist function)|Add]]</var> and <var>Enqueue</var> methods are the same. Enqueue was designed as a convenience for use with the <var>[[Dequeue (Stringlist function)|Dequeue]]</var>.
<li> Available in <var class=product>Sirius Mods</var> version 7.0 and later.</ul>


[[Category:Stringlist methods|Enqueue function]]
==See also==
{{Template:Stringlist:Enqueue 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. Enqueue accepts one argument and returns a numeric result.

Syntax

[%count =] sl:Enqueue( string)

Syntax terms

%count An, optional, 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 newly added string in the Stringlist.
sl A Stringlist object.
string A new string that is to be added to the end of 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 Add and Enqueue methods are the same. Enqueue was designed as a convenience for use with the Dequeue.
  • Available in Sirius Mods version 7.0 and later.

See also