$ListILn: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Length of $list item</span> | <span class="pageSubtitle">Length of $list item</span> | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is <var>[[ItemLength (Stringlist function)|ItemLength]]</var>.</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. | ||
| Line 18: | Line 18: | ||
<p> | <p> | ||
<var class="term">%result</var> is a string that contains the length of the indicated $list item, or it is a negative number if an error has occurred.</p> | <var class="term">%result</var> is a string that contains the length of the indicated $list item, or it is a negative number if an error has occurred.</p> | ||
===Error codes=== | |||
<p class="code">-5 - Required argument not specified | <p class="code">-5 - Required argument not specified | ||
-6 - $List identifier invalid | -6 - $List identifier invalid | ||
-7 - Item number not found in $list | -7 - Item number not found in $list | ||
</p> | </p> | ||
Revision as of 22:33, 18 July 2013
Length of $list item
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is ItemLength.
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
%result = $ListILn(list_identifier, item_num)
%result is a string that contains the length of the indicated $list item, or it is a negative number if an error has occurred.
Error codes
-5 - Required argument not specified -6 - $List identifier invalid -7 - Item number not found in $list