$ListInf
Retrieve $list item into string
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListInf function is the Item function.
This function returns a string containing specified bytes of the current contents of a specified $list item or a negative number indicating that an error has occurred.
The $ListInf function accepts four arguments and returns a string result.
The first argument is a $list identifier. This is a required argument.
The second argument is the number of the item in the $list. This is a required argument.
The third argument is either a number that specifies the starting column from which data is to be returned, or it is a string containing the name of an image item in the image associated with the $list using $ListImg. In the latter case, the start column for returned data is the position of the image item in the image. This is an optional argument and it defaults to 1.
The fourth argument is a number that indicates the number of columns (characters) to be returned. This is an optional argument and defaults to one of the following values:
- The length of the image item (if the third argument specifies an image item name).
- 255 (the maximum bytes that can be returned by a $function).
If the default or explicit length specified by the fourth argument is more than the number of characters after the start column in the requested $list item, only the characters to the end of the $list item are returned.
Syntax
%result = $ListInf(list_identifier, item_num, [start_col], [length])
%result is a string that contains the indicated piece 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 -9 - Invalid start column or length