$ListNewI: Difference between revisions
m (misc cleanup) |
m (add link) |
||
Line 4: | Line 4: | ||
<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListNewI</var> function is the <var>[[New (Stringlist constructor)|New]]</var> constructor. </p> | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListNewI</var> function is the <var>[[New (Stringlist constructor)|New]]</var> constructor. </p> | ||
<var>$ListNewI</var> 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. | <var>$ListNewI</var> creates an empty $list. The created $list is associated with an [[Images|image]] exactly as if the <var>[[$ListNew]]</var> call was followed by a <var>[[$ListImg]]</var> call. | ||
The <var>$ListNewI</var> function accepts two arguments and returns a numeric result. | The <var>$ListNewI</var> function accepts two arguments and returns a numeric result. |
Revision as of 21:16, 6 June 2018
Create empty $list associated with image
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNewI function is the New constructor.
$ListNewI 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.
Syntax
%result = $ListNewI(image_id, [option])
%result | A numeric variable set to the identifier of the created empty $list.
No error codes are associated with $ListNewI, though the absence of the image identifier or an invalid image identifier will cause request cancellation. |
---|---|
image_id | A string that contains the name of an image, or the name of any image item from the required image. |
option | Specifying the string NOREL indicates that the contents of the $list are not to be emptied when a Release All Records statement is executed. |
Usage notes
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.