FirstItem (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:FirstItem subtitle}} | {{Template:Stringlist:FirstItem subtitle}} | ||
This method returns the current contents of the first item in the method object Stringlist. FirstItem is available in <var class=product>Sirius Mods</var> version 7.0 and later. | This method returns the current contents of the first item in the method object <var>Stringlist</var>. FirstItem 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 first '''%sl''' item. </td></tr> | <td>This longstring is to contain the contents of the first '''%sl''' item. </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 FirstItem result in request cancellation.<li>The FirstItem method for object %sl is equivalent to specifying <tt>.%sl:Item(1)</tt>. See the [[Item (Stringlist function)]] page. | <li>All errors in FirstItem result in request cancellation.<li>The FirstItem method for object %sl is equivalent to specifying <tt>.%sl:Item(1)</tt>. See the [[Item (Stringlist function)]] page. | ||
<li>The [[LastItem (Stringlist function)]] retrieves just the last item in a Stringlist.</ul> | <li>The [[LastItem (Stringlist function)]] retrieves just the last item in a <var>Stringlist</var>.</ul> | ||
[[Category:Stringlist methods|FirstItem function]] | [[Category:Stringlist methods|FirstItem function]] | ||
Revision as of 21:33, 18 January 2011
Retrieve value of first Stringlist item (Stringlist class)
This method returns the current contents of the first item in the method object Stringlist. FirstItem is available in Sirius Mods version 7.0 and later.
Syntax
%string = sl:FirstItem
Syntax terms
| %string | This longstring is to contain the contents of the first %sl item. |
|---|---|
| sl | A Stringlist object. |
Usage notes
- All errors in FirstItem result in request cancellation.
- The FirstItem method for object %sl is equivalent to specifying .%sl:Item(1). See the Item (Stringlist function) page.
- The LastItem (Stringlist function) retrieves just the last item in a Stringlist.