LastItem (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (syntax digram, tags and links)
Line 1: Line 1:
{{Template:Stringlist:LastItem subtitle}}
{{Template:Stringlist:LastItem subtitle}}


This method returns the current contents of the last item in the method object <var>Stringlist</var>. <var>LastItem</var> is available in <var class=product>Sirius Mods</var> version 7.0 and later.
This method returns the current contents of the last item in the method object <var>Stringlist</var>.
 
<var>LastItem</var> is available in <var class=product>Sirius Mods</var> version 7.0 and later.


==Syntax==
==Syntax==
Line 8: Line 10:
<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 '''%sl''' item. </td></tr>
<td>This string receives the contents of the last <var class="term">sl</var> item. </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 16: Line 18:
<ul>
<ul>
<li>All errors in <var>LastItem</var> result in request cancellation.
<li>All errors in <var>LastItem</var> result in request cancellation.
<li>The <var>LastItem</var> method for object %sl is equivalent to specifying<tt>.%sl:Item(%sl:count)</tt>. (see [[Item (Stringlist function)]].
<li>The <var>LastItem</var> method for object <var class="term">sl</var> is equivalent to specifying <var class="term">%sl:[[Item (Stringlist function)|Item]](%sl:count)</var>.
<li>The [[FirstItem (Stringlist function)]] retrieves just the first item in a <var>Stringlist</var>.</ul>
<li>See also:<ul><li><var>[[Item (Stringlist function)|Item]]</var> which retrieves the n'th item in a <var>Stringlist</var>
<li><var>[[FirstItem (Stringlist function)|FirstItem]]</var> which retrieves just the first item in a <var>Stringlist</var>.</ul></ul>


[[Category:Stringlist methods|LastItem function]]
[[Category:Stringlist methods|LastItem function]]

Revision as of 06:57, 26 January 2011

Retrieve value of last Stringlist item (Stringlist class)


This method returns the current contents of the last item in the method object Stringlist.

LastItem is available in Sirius Mods version 7.0 and later.

Syntax

%string = sl:LastItem

Syntax terms

%string This string receives the contents of the last sl item.
sl A Stringlist object.

Usage notes

  • All errors in LastItem result in request cancellation.
  • The LastItem method for object sl is equivalent to specifying %sl:Item(%sl:count).
  • See also:
    • Item which retrieves the n'th item in a Stringlist
    • FirstItem which retrieves just the first item in a Stringlist.