$ListNewI: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| 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="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNewI function is the [[New (Stringlist constructor)]].</p> | <p class="warning">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 [[$ListNew]] call was followed by a [[$ListImg]] 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. | ||
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. | ||
The first argument can either be a string containing the name of an image or any image item from the required image | 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 <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, option) | <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> | </p> | ||
<p> | <p> | ||
< | <var class="term">%result</var> is set to the identifier of the created empty $list.</p> | ||
< | |||
There are no error codes associated with <var>$ListNewI</var> though the absence of the image identifier or an invalid image identifier will cause request cancellation. | There are no error codes associated with <var>$ListNewI</var> though the absence of the image identifier or an invalid image identifier will cause request cancellation. | ||
All invocations of a particular call to <var>$ListNewI</var> 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. | All invocations of a particular call to <var>$ListNewI</var> 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 {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 37: | Line 35: | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListNewI]] | [[Category:$Functions|$ListNewI]] | ||
Revision as of 14:23, 11 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.