$ListILn: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Automatically generated page update)
 
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 <var>[[ItemLength (Stringlist function)|ItemLength]]</var>.</p>
<p class="warn"><b>Note: </b>Many $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.  

Latest revision as of 22:51, 20 September 2018

Length of $list item

Note: Many $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

Products authorizing $ListILn