$ListNewI

From m204wiki
Revision as of 21:15, 6 June 2018 by JAL (talk | contribs) (misc cleanup)
Jump to navigation Jump to search

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.

Products authorizing $ListNewI