Dequeue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Dequeue subtitle}} | {{Template:Stringlist:Dequeue subtitle}} | ||
This callable method returns the current contents of the first item in the method object <var>Stringlist</var>, then it removes that first item | This [[Notation conventions for methods#Callable functions|callable]] method returns the current contents of the first item in the method object <var>Stringlist</var>, then it removes that first item. | ||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string </th> | <tr><th>%string</th> | ||
<td>This | <td>This string is to contain the contents of the first item in <var class="term">sl</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> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul><li>All errors in <var>Dequeue</var> result in request cancellation. | ||
<li>All errors in Dequeue result in request cancellation. | <li> <var>Dequeue</var> is available in <var class="product">Sirius Mods</var> version 7.0 and later. | ||
<li> | |||
</ul> | </ul> | ||
[[ | ==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}} | |||
Latest revision as of 19:40, 14 July 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.
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.
- Dequeue is available in Sirius Mods version 7.0 and later.
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.