FirstItem (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (syntax digram, tags and links) |
||
| 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 <var>Stringlist</var>. <var>FirstItem</var> 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>. | ||
<var>FirstItem</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 | <td>This string is to receive the contents of the first <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 15: | Line 17: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All errors in <var>FirstItem</var> result in request cancellation.<li>The <var>FirstItem</var> method for object %sl is equivalent to specifying < | <li>All errors in <var>FirstItem</var> result in request cancellation.<li>The <var>FirstItem</var> method for object <var class="term">%sl</var> is equivalent to specifying <var class="term">%sl:</var><var>[[Item (Stringlist function)|Item]]</var><var class="term">(1)</var>. | ||
<li> | <li>See also:<ul><li>[[LastItem (Stringlist function)|LastItem]] which retrieves just the last item in a <var>Stringlist</var>.</ul></ul> | ||
[[Category:Stringlist methods|FirstItem function]] | [[Category:Stringlist methods|FirstItem function]] | ||
Revision as of 04:57, 26 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 string is to receive the contents of the first sl item. |
|---|---|
| sl | A Stringlist object. |