Pop (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (syntax digram, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Pop subtitle}} | {{Template:Stringlist:Pop subtitle}} | ||
This callable method returns the current contents of the last item in the method object <var>Stringlist</var>, then it removes that last item | This callable method returns the current contents of the last item in the method object <var>Stringlist</var>, then it removes that last item. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th> | <tr><th>%string</th> | ||
<td>This longstring is to contain the contents of the last item in | <td>This longstring is to contain the contents of the last 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> | ||
| Line 14: | Line 14: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul><li>All errors in <var>Pop</var> result in request cancellation. | ||
<li>All errors in <var>Pop</var> result in request cancellation. | |||
<li> | <li> <var>Pop</var> is available in <var class=product>Sirius Mods</var> version 7.0 and later.</ul> | ||
</ul> | |||
==See also== | ==See also== | ||
<ul><li><var>[[LastItem (Stringlist function)|LastItem]]</var> returns the last item of a Stringlist without removing it.<li> [[Push (Stringlist function)|Push]], a synonym for the [[Add (Stringlist function)|Add]], appends a string to a <var>Stringlist</var>.</ul> | |||
{{Template:Stringlist:Pop footer}} | {{Template:Stringlist:Pop footer}} | ||
Revision as of 05:13, 27 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.
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, appends a string to a Stringlist.