Item (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (syntax digram, tags and links)
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Stringlist:Item subtitle}}
{{Template:Stringlist:Item subtitle}}
This method returns the current contents of a specified <var>Stringlist</var> item.
The <var>Item</var> method accepts one argument and returns a string result.


==Syntax==
==Syntax==
{{Template:Stringlist:Item syntax}}
{{Template:Stringlist:Item syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 13: Line 10:
<tr><th>sl</th>
<tr><th>sl</th>
<td>A <var>Stringlist</var> object. </td></tr>
<td>A <var>Stringlist</var> object. </td></tr>
<tr><th>itemnum</th>
<tr><th>itemNum</th>
<td>The number of the item in the <var class="term">sl</var> <var>Stringlist</var>.</td></tr>
<td>The number of the item in the <var class="term">sl</var> <var>Stringlist</var>.</td></tr>
</table>
</table>
Line 20: Line 17:
<ul>
<ul>
<li>All errors in <var>Item</var> result in request cancellation.
<li>All errors in <var>Item</var> result in request cancellation.
<li>Unlike the <var>[[Item (Arraylist property)|Item]]</var> method for <var>collections</var>, the <var>Item</var> method for <var>stringlists</var> is not settable. To set a new value for a <var>stringlist</var> item, use [[Replace (Stringlist function)|Replace]].<li>There are optimized methods available to retrieve just the first or just the last item in a <var>Stringlist</var>. See also:<ul><li><var>[[FirstItem (Stringlist function)|FirstItem]]</var> and<li><var>[[LastItem (Stringlist function)|LastItem]]</var>.</ul></ul>
<li>Unlike the <var>[[Item (Arraylist property)|Item]]</var> method for <var>[[Collections]]</var>, the <var>Item</var> method for <var>stringlists</var> is not settable. To set a new value for a <var>stringlist</var> item, use <var>[[Replace (Stringlist function)|Replace]]</var>.</ul>


==Examples==
==Examples==
The following loop uses the <var>Item</var> method to display the contents of a <var>Stringlist</var>:
<ol><li>The following loop uses the <var>Item</var> method to display the contents of a <var>Stringlist</var>:


<p class="code">for %i from 1 to %list:count
<p class="code">for %i from 1 to %list:count
  print %list:item(%i)
print %list:item(%i)
end for
end for
</p>
</p>
Line 35: Line 32:
</p>
</p>


Under <var class="product">Sirius Mods</var> Version 6.8 and later, the method name, <var>Item</var>, is not necessary on a <var>Stringlist</var> <var>Item</var> reference. For example, the previous program with <var>Item</var> references could be written as:
<Li>Under <var class="product">Sirius Mods</var> Version 6.8 and later, the method name, <var>Item</var>, is not necessary on a <var>Stringlist</var> <var>Item</var> reference. For example, the previous program with <var>Item</var> references could be written as:


<p class="code">for %i from 1 to %list:count
<p class="code">for %i from 1 to %list:count
   print %list(%i)
   print %list(%i)
end for
end for
</p>
</p></ol>


==See also==
==See also==
There are optimized methods available to retrieve just the first or just the last item in a <var>Stringlist</var>:
<ul>
<li><var>[[FirstItem (Stringlist function)|FirstItem]]</var>
<li><var>[[LastItem (Stringlist function)|LastItem]]</var>
</ul>
{{Template:Stringlist:Item footer}}
{{Template:Stringlist:Item footer}}

Latest revision as of 17:43, 1 June 2012

Retrieve value of Stringlist item (Stringlist class)


Syntax

%string = sl:Item( itemNum)

Syntax terms

%string This longstring is to contain the contents of the sl item.
sl A Stringlist object.
itemNum The number of the item in the sl Stringlist.

Usage notes

  • All errors in Item result in request cancellation.
  • Unlike the Item method for Collections, the Item method for stringlists is not settable. To set a new value for a stringlist item, use Replace.

Examples

  1. The following loop uses the Item method to display the contents of a Stringlist:

    for %i from 1 to %list:count print %list:item(%i) end for

    This could be accomplished much more easily with:

    %list:print

  2. Under Sirius Mods Version 6.8 and later, the method name, Item, is not necessary on a Stringlist Item reference. For example, the previous program with Item references could be written as:

    for %i from 1 to %list:count print %list(%i) end for

See also

There are optimized methods available to retrieve just the first or just the last item in a Stringlist: