FirstItem (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:FirstItem subtitle}} | |||
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. | 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. | ||
| Line 5: | Line 5: | ||
FirstItem is a member of the [[Stringlist class]]. | FirstItem is a member of the [[Stringlist class]]. | ||
== | ==Syntax== | ||
{{Template:Stringlist:FirstItem syntax}} | |||
===Syntax terms=== | |||
===Syntax | |||
<dl> | <dl> | ||
<dt>%string<dd>This longstring is to contain the contents of the first '''%sl''' item. | <dt>%string<dd>This longstring is to contain the contents of the first '''%sl''' item. | ||
| Line 17: | Line 14: | ||
</dl> | </dl> | ||
==Usage | ==Usage notes== | ||
<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. | ||
Revision as of 17:49, 31 December 2010
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.
FirstItem is a member of the Stringlist class.
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.