$ListILn: Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle">Length of $list item</span> | <span class="pageSubtitle">Length of $list item</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is the [[ItemLength (Stringlist function)]].</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListILn</var> function is the [[ItemLength (Stringlist function)]].</p> | ||
This function returns a number containing the length of a specified $list item, or it returns a negative number indicating that an error has occurred. | This function returns a number containing the length of a specified $list item, or it returns a negative number indicating that an error has occurred. | ||
The $ListILn function accepts two arguments and returns a numeric result. | The <var>$ListILn</var> function accepts two arguments and returns a numeric result. | ||
The first argument is a $list identifier. This is a required argument. | The first argument is a $list identifier. This is a required argument. |
Revision as of 19:25, 19 October 2012
Length of $list item
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is the ItemLength (Stringlist function).
This function returns a number containing the length of a specified $list item, or it returns a negative number indicating that an error has occurred.
The $ListILn function accepts two arguments and returns a numeric result.
The first argument is a $list identifier. This is a required argument.
The second argument is a string that specifies the item number in the $list. This is a required argument.
Syntax
<section begin="syntax" /> %RESULT = $ListILn(list_identifier, item_num) <section end="syntax" />
-5 - Required argument not specified -6 - $List identifier invalid -7 - Item number not found in $list