Dequeue (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<span style="font-size:120%"><b>Retrieve value of first Stringlist item, then remove item</b></span>
{{Template:Stringlist:Dequeue subtitle}}


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.
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.
Line 5: Line 5:
Dequeue is a member of the [[Stringlist class]].
Dequeue is a member of the [[Stringlist class]].


==Dequeue Syntax==
==Syntax==
<pre>
{{Template:Stringlist:Dequeue syntax}}
%string = %sl:Dequeue
===Syntax terms===
</pre>
 
===Syntax Terms===
<dl>
<dl>
<dt>%string
<dt>%string
Line 18: Line 15:
</dl>
</dl>


==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>All errors in Dequeue result in request cancellation.
<li>All errors in Dequeue result in request cancellation.

Revision as of 22:03, 4 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.

Dequeue is a member of the Stringlist class.

Syntax

[%string =] sl:Dequeue

Syntax terms

%string
This longstring is to contain the contents of the first item in %sl.
%sl
A Stringlist object.

Usage notes