LastItem (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(8 intermediate revisions by 2 users not shown)
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>. LastItem 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>.


==Syntax==
==Syntax==
Line 7: Line 7:
===Syntax terms===
===Syntax terms===
<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>
</table>
</table>
Line 15: Line 15:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>All errors in LastItem result in request cancellation.
<li>All errors in <var>LastItem</var> result in request cancellation.
<li>The LastItem method for object %sl is equivalent to specifying<tt>.%sl:Item(%sl:count)</tt>. (see [[Item (Stringlist function)]].
<li>Calling <var>LastItem</var> for object <code>%sl</code> is equivalent to specifying <code>%sl:[[Item (Stringlist function)|Item]](%sl:count)</code>.
<li>The [[FirstItem (Stringlist function)]] retrieves just the first item in a <var>Stringlist</var>.</ul>
<li><var>LastItem</var> is available in <var class="product">Sirius Mods</var> version 7.0 and later.
</ul>


[[Category:Stringlist methods|LastItem function]]
==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>
{{Template:Stringlist:LastItem footer}}

Latest revision as of 15:44, 31 October 2012

Retrieve value of last Stringlist item (Stringlist class)


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

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.
  • Calling LastItem for object %sl is equivalent to specifying %sl:Item(%sl:count).
  • LastItem is available in Sirius Mods version 7.0 and later.

See also

  • Item which retrieves the n'th item in a Stringlist
  • FirstItem which retrieves just the first item in a Stringlist.