Pop (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| 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 Stringlist, then it removes that last item. Pop is available in <var class=product>Sirius Mods</var> version 7.0 and later. | This 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 available in <var class=product>Sirius Mods</var> version 7.0 and later. | ||
==Syntax== | ==Syntax== | ||
| Line 10: | Line 10: | ||
<td>This longstring is to contain the contents of the last item in '''%sl'''. </td></tr> | <td>This longstring is to contain the contents of the last item in '''%sl'''. </td></tr> | ||
<tr><th>sl </th> | <tr><th>sl </th> | ||
<td>A Stringlist object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
</table> | </table> | ||
| Line 16: | Line 16: | ||
<ul> | <ul> | ||
<li>All errors in Pop result in request cancellation. | <li>All errors in Pop result in request cancellation. | ||
<li>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. | <li>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 <var>Stringlist</var>. | ||
</ul> | </ul> | ||
[[Category:Stringlist methods|Pop function]] | [[Category:Stringlist methods|Pop function]] | ||
Revision as of 21:33, 18 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.
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.