Enqueue (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (usage notes)
mNo edit summary
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>.  <var>Enqueue</var> accepts one argument and returns a numeric result.
This [[Notation conventions for methods#Callable methods|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==

Revision as of 02:04, 9 March 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