ItemLength (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
m (camelCase)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<span style="font-size:120%"><b>Length of Stringlist item</b></span>
{{Template:Stringlist:ItemLength subtitle}}


This method returns a number containing the length of a specified Stringlist item.
This method returns a number containing the length of a specified <var>stringlist</var> item.


ItemLength is a member of the [[Stringlist class]].
==Syntax==
{{Template:Stringlist:ItemLength syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%length</th>
<td>A numeric variable which will be set to the length of the selected <var class="term">sl</var> <var>Stringlist</var> item. </td></tr>
<tr><th>sl</th>
<td>A <var>Stringlist</var> object.</td></tr>
<tr><th>itemNum</th>
<td>A number that specifies that identifies the item number in the <var class="term">sl</var> <var>Stringlist</var> whose length is to be returned.</td></tr>
</table>


==ItemLength Syntax==
==Usage notes==
<pre>
%rc = %sl:ItemLength(itemnum)
</pre>
 
===Syntax Terms===
<dl>
<dt>%rc
<dd>A numeric variable set to the length of the '''%sl''' Stringlist item.
<dt>%sl
<dd>A Stringlist object.<dt>itemnum<dd>A number that specifies the item number in the '''%sl''' Stringlist.
</dl>
 
==Usage Notes==
<ul>
<ul>
<li>All errors in ItemLength result in request cancellation.
<li>All errors in <var>ItemLength</var> result in request cancellation.
</ul>
</ul>


[[Category:Stringlist methods|ItemLength function]]
==See also==
{{Template:Stringlist:ItemLength footer}}

Latest revision as of 00:02, 27 January 2011

Length of Stringlist item (Stringlist class)


This method returns a number containing the length of a specified stringlist item.

Syntax

%length = sl:ItemLength( itemNum)

Syntax terms

%length A numeric variable which will be set to the length of the selected sl Stringlist item.
sl A Stringlist object.
itemNum A number that specifies that identifies the item number in the sl Stringlist whose length is to be returned.

Usage notes

  • All errors in ItemLength result in request cancellation.

See also