$ListNew: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Create empty $list</span> | <span class="pageSubtitle">Create empty $list</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNew 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 $ListNew function is the <var>[[New (Stringlist constructor)|New]]</var> constructor.</p> | ||
This function creates an empty $list. | This function creates an empty $list. | ||
| Line 8: | Line 8: | ||
The <var>$ListNew</var> function accepts one argument and returns a numeric result. | The <var>$ListNew</var> function accepts one argument and returns a numeric result. | ||
The 1st 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 | The 1st 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">$ListNew</span>(<span class="term">option) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$ListNew</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>$ListNew</var>. | There are no error codes associated with <var>$ListNew</var>. | ||
All invocations of a particular call to <var>$ListNew</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>$ListNew</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 30: | Line 31: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListNew]] | [[Category:$Functions|$ListNew]] | ||
Revision as of 14:20, 11 April 2013
Create empty $list
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNew function is the New constructor.
This function creates an empty $list.
The $ListNew function accepts one argument and returns a numeric result.
The 1st 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 = $ListNew([option])
%result is set to the identifier of the created empty $list.
There are no error codes associated with $ListNew.
All invocations of a particular call to $ListNew 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.