$ListNewI: Difference between revisions
mNo edit summary |
(Automatically generated page update) |
||
| Line 12: | Line 12: | ||
The second argument, if set to the string <tt>NOREL</tt>, indicates that the contents of the $list are not to be emptied when a RELEASE ALL RECORDS statement is executed. | The second argument, if set to the string <tt>NOREL</tt>, indicates that the contents of the $list are not to be emptied when a RELEASE ALL RECORDS statement is executed. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$ListNewI</span>(<span class="term">image_id</span>, [<span class="term">option</span>]) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$ListNewI</span>(<span class="term">image_id</span>, <span class="term"></span>[<span class="term">option</span>]) | ||
</p> | </p> | ||
Revision as of 18:30, 12 April 2013
Create empty $list associated with image
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNewI function is the New constructor.
This function creates an empty $list. The created $list is associated with an image exactly as if the $ListNew call was followed by a $ListImg call.
The $ListNewI function accepts two arguments and returns a numeric result.
The first argument can either be a string containing the name of an image or any image item from the required image.
The second argument, if set to the string NOREL, indicates that the contents of the $list are not to be emptied when a RELEASE ALL RECORDS statement is executed.
Syntax
%result = $ListNewI(image_id, [option])
%result is set to the identifier of the created empty $list.
There are no error codes associated with $ListNewI though the absence of the image identifier or an invalid image identifier will cause request cancellation.
All invocations of a particular call to $ListNewI will always return the same value. Each time that call is executed, any previous $list created by that call is deleted, and a new list is created.