Dequeue (Stringlist function)

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.

See also

Stringlist class	List of Stringlist methods	Stringlist methods syntax
Notation conventions for methods