Pop (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Pop subtitle}} | |||
This callable method returns the current contents of the last item in the method object Stringlist, then it removes that last item. Pop is available in ''[[Sirius Mods]]'' version 7.0 and later. | This callable method returns the current contents of the last item in the method object Stringlist, then it removes that last item. Pop is available in ''[[Sirius Mods]]'' version 7.0 and later. | ||
| Line 5: | Line 5: | ||
Pop is a member of the [[Stringlist class]]. | Pop is a member of the [[Stringlist class]]. | ||
== | ==Syntax== | ||
{{Template:Stringlist:Pop syntax}} | |||
===Syntax terms=== | |||
===Syntax | |||
<dl> | <dl> | ||
<dt>%string | <dt>%string | ||
| Line 18: | Line 15: | ||
</dl> | </dl> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All errors in Pop result in request cancellation. | <li>All errors in Pop result in request cancellation. | ||
Revision as of 22:04, 4 January 2011
Retrieve value of last Stringlist item, then remove last item (Stringlist class)
This callable method returns the current contents of the last item in the method object Stringlist, then it removes that last item. Pop is available in Sirius Mods version 7.0 and later.
Pop is a member of the Stringlist class.
Syntax
[%string =] sl:Pop
Syntax terms
- %string
- This longstring is to contain the contents of the last item in %sl.
- %sl
- A Stringlist object.
Usage notes
- All errors in Pop result in request cancellation.
- The LastItem (Stringlist function) returns the last item of a Stringlist without removing it. The Push (Stringlist function), a synonym for the Add (Stringlist function), appends a string to a Stringlist.