Add longstring as new $list item
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListAdd_Lstr function is the Add function. Note that because Stringlists are longstring capabable, no special longstring methods are required.
This function adds longstring data to a $list. Generally, this $list would have been created with the $ListNew function.
The $ListAdd_Lstr function accepts two arguments and returns a numeric result. It is a callable $function.
The first argument is a $list identifier. This is a required argument.
The second argument is a longstring that is to be added to the $list. This is a required argument.
[%RESULT =] $ListAdd_Lstr(list_identifier, string)
%result is set either to the number of items in the indicated $list after the string has been added to the $list, or to a negative number if an error has occurred. Note that in the former case, %result is also the item number associated with the added string in the $list.
-3 - No room to add item (if LISTFC $SirParm parameter not set) All other errors cause request cancellation
- $ListAdd_Lstr works almost exactly like $ListAdd except:
- It accepts a LONGSTRING input. $ListAdd_Lstr can be used with regular strings as well to pick up automatic request cancellation on programming errors.
- It cancels the request on any errors such as invalid $list identifier or invalid $list item number.
- It does not have an item length argument (argument 3 in $ListAdd).