Enqueue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Enqueue subtitle}} | |||
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. | 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. | ||
| Line 5: | Line 5: | ||
Enqueue is a member of the [[Stringlist class]]. | Enqueue is a member of the [[Stringlist class]]. | ||
== | ==Syntax== | ||
{{Template:Stringlist:Enqueue syntax}} | |||
===Syntax terms=== | |||
===Syntax | |||
<dl> | <dl> | ||
<dt>%rc | <dt>%rc | ||
| Line 18: | Line 15: | ||
</dl> | </dl> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All errors result in request cancellation. | <li>All errors result in request cancellation. | ||
Revision as of 17:48, 31 December 2010
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.
Enqueue is a member of the Stringlist class.
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).