$ListNewI: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
m (misc cleanup) |
||
| 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="warn"><b>Note: </b> | <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. | |||
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. | ||
==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">option</span>]) | ||
</p> | </p> | ||
< | <table> | ||
< | <tr><th>%result</th> | ||
<td>A numeric variable set to the identifier of the created empty $list. | |||
<p>No error codes are associated with <var>$ListNewI</var>, though the absence of the image identifier or an invalid image identifier will cause request cancellation. </p></td></tr> | |||
<tr><th>image_id</th> | |||
<td>A string that contains the name of an image, or the name of any image item from the required image. </td></tr> | |||
<tr><th>option</th> | |||
<td>Specifying the string <code>NOREL</code> indicates that the contents of the $list are not to be emptied when a <var>Release All Records</var> statement is executed. </td></tr> | |||
</table> | |||
==Usage notes== | |||
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}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[ | <li>[[Sirius Functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
| Line 32: | Line 37: | ||
<li>Japanese functions</li> | <li>Japanese functions</li> | ||
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListNewI]] | [[Category:$Functions|$ListNewI]] | ||
Revision as of 21:15, 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.