$ListNewI: Difference between revisions
(Automatically generated page update) |
(Automatically generated page update) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Create empty $list associated with image</span> | <span class="pageSubtitle">Create empty $list associated with image</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNewI function is the <var>[[New (Stringlist constructor)|New]]</var> constructor.</p> | ||
This function creates an empty $list. The created $list is associated with an image exactly as if the <var>[[$ListNew]]</var> call was followed by a <var>[[$ListImg]]</var> call. | This function creates an empty $list. The created $list is associated with an image exactly as if the <var>[[$ListNew]]</var> call was followed by a <var>[[$ListImg]]</var> call. | ||
Revision as of 20:54, 18 July 2013
Create empty $list associated with image
Note: 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.