Pop (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→See also) |
||
| (21 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Pop subtitle}} | |||
This method returns the current contents of the last item in the method object Stringlist, then it removes that last item | This [[Notation conventions for methods#Callable functions|callable]] method returns the current contents of the last item in the method object <var>Stringlist</var>, then it removes that last item. | ||
Pop is | ==Syntax== | ||
{{Template:Stringlist:Pop syntax}} | |||
===Syntax terms=== | |||
<table class="syntaxTable"> | |||
<tr><th>%string</th> | |||
<td>This longstring is to contain the contents of the last item in <var class="term">sl</var>. </td></tr> | |||
<tr><th>sl</th> | |||
<td>A <var>Stringlist</var> object.</td></tr> | |||
</table> | |||
== | ==Usage notes== | ||
< | <ul><li>All errors in <var>Pop</var> result in request cancellation. | ||
</ | |||
<li> <var>Pop</var> is available in <var class=product>Sirius Mods</var> version 7.0 and later.</ul> | |||
< | |||
< | |||
< | |||
< | |||
< | |||
</ | |||
== | ==See also== | ||
<ul> | <ul> | ||
<li> | <li><var>[[LastItem (Stringlist function)|LastItem]]</var> returns the last item of a <var>Stringlist</var> without removing it. | ||
< | |||
<li> <var>[[Push (Stringlist function)|Push]]</var>, a synonym for the <var>[[Add (Stringlist function)|Add]]</var> method, appends a string to a <var>Stringlist</var>. | |||
</ul> | </ul> | ||
{{Template:Stringlist:Pop footer}} | |||
Latest revision as of 19:32, 31 October 2012
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.
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.
- Pop is available in Sirius Mods version 7.0 and later.
See also
- LastItem returns the last item of a Stringlist without removing it.
- Push, a synonym for the Add method, appends a string to a Stringlist.