$ListNew: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (misc cleanup) |
||
| (36 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$ListNew}} | |||
<span class="pageSubtitle">Create empty $list</span> | |||
<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListNew</var> function is the <var>[[New (Stringlist constructor)|New]]</var> constructor.</p> | |||
The <var>$ListNew</var> function creates an empty $list. It | |||
accepts one argument and returns a numeric result. | |||
==Syntax== | |||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$ListNew</span>([<span class="term">option</span>]) | |||
</p> | |||
<table> | |||
<tr><th>%result</th> | |||
<td>A numeric variable that is set to the identifier of the created empty $list. | |||
<p> | |||
No error codes are associated with <var>$ListNew</var>. </p></td></tr> | |||
<tr><th>option</th> | |||
<td>The string <code>NOREL</code> indicates that the contents of the $list are not to be emptied if a <var>Release All Records</var> statement is executed. </td></tr> | |||
</table> | |||
==Usage notes== | |||
<ul> | |||
<li>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. </li> | |||
<li><var>$ListNew</var> is not allowed in the <var>Initial</var> clause of a [[Using variables and values in computation#Declare statements for %variables|declaration statement]]. </li> | |||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | |||
<li>[[Sirius Functions]]</li> | |||
<li>[[Fast/Unload User Language Interface]]</li> | |||
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | |||
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | |||
<li>[[Janus Sockets]]</li> | |||
<li>[[Janus Web Server]]</li> | |||
<li>Japanese functions</li> | |||
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | |||
</ul> | |||
[[Category:$Functions|$ListNew]] | |||
Latest revision as of 21:21, 15 February 2018
Create empty $list
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListNew function is the New constructor.
The $ListNew function creates an empty $list. It accepts one argument and returns a numeric result.
Syntax
%result = $ListNew([option])
| %result | A numeric variable that is set to the identifier of the created empty $list.
No error codes are associated with $ListNew. |
|---|---|
| option | The string NOREL indicates that the contents of the $list are not to be emptied if a Release All Records statement is executed. |
Usage notes
- 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.
- $ListNew is not allowed in the Initial clause of a declaration statement.