$ListAdd Lstr: Difference between revisions
m (1 revision) |
m (1 revision) |
(No difference)
|
Revision as of 20:44, 24 October 2012
Add longstring as new $list item
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListAdd_Lstr function is the Add (Stringlist 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 (see Calling Sirius Mods $functions).
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.
Syntax
<section begin="syntax" />[%RESULT =] $ListAdd_Lstr(list_identifier, string) <section end="syntax" />
-3 - No room to add item (if LISTFC $SirParm parameter not set) All other errors cause request cancellation
Before Sirius Mods Version 6.6, it was a request cancelling error to try to add a longstring longer than the size limit of a $list item: 6124 bytes. This limitation was eliminated in Sirius Mods Version 6.6.
$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).
$ListAdd_Lstr is available in Sirius Mods Version 6.2 and later.