Dequeue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
m (see also) |
||
| Line 14: | Line 14: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul><li>All errors in <var>Dequeue</var> result in request cancellation. | ||
<li>All errors in <var>Dequeue</var> result in request cancellation. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
<ul><li><var>[[FirstItem (Stringlist function)|FirstItem]]</var>, which returns the first item of a Stringlist without removing it.<li><var>[[Pop (Stringlist function)|Pop]]</var>, which returns the last item of a <var>Stringlist</var>, then removes it.</ul> | |||
{{Template:Stringlist:Dequeue footer}} | {{Template:Stringlist:Dequeue footer}} | ||
Revision as of 01:34, 27 January 2011
Retrieve value of first Stringlist item, then remove item (Stringlist class)
This callable method returns the current contents of the first item in the method object Stringlist, then it removes that first item. Dequeue is available in Sirius Mods version 7.0 and later.
Syntax
[%string =] sl:Dequeue
Syntax terms
| %string | This string is to contain the contents of the first item in sl. |
|---|---|
| sl | A Stringlist object. |
Usage notes
- All errors in Dequeue result in request cancellation.
See also
- FirstItem, which returns the first item of a Stringlist without removing it.
- Pop, which returns the last item of a Stringlist, then removes it.