$ListNew: Difference between revisions
mNo edit summary |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$ListNew}} | |||
<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> | |||
This function creates an empty $list. | |||
The <var>$ListNew</var> function accepts one argument and returns a numeric result. | |||
The first 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. This is an optional argument. | |||
==Syntax== | |||
<p class="syntax"><section begin="syntax" />%result = $ListNew(option) | |||
<section end="syntax" /></p> | |||
<p> | |||
</p> | |||
<p>%result is set to the identifier of the created empty $list.</p> | |||
There are no error codes associated with <var>$ListNew</var>. | |||
All invokatians 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.<p> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | |||
<li>[[Sirius functions]]</li> | |||
<li>[[Fast/Unload User Language Interface]]</li> | |||
<li>[[Janus Open Client]]</li> | |||
<li>[[Janus Open Server]]</li> | |||
<li>[[Janus Sockets]]</li> | |||
<li>[[Janus Web Server]]</li> | |||
<li>[[Japanese functions]]</li> | |||
<li>[[Sir2000 Field Migration Facility]]</li> | |||
</ul> | |||
</p> | |||
<p> | |||
</p> | |||
[[Category:$Functions|$ListNew]] | |||
Revision as of 17:41, 28 January 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 (Stringlist constructor).
This function creates an empty $list.
The $ListNew function accepts one argument and returns a numeric result.
The first 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. This is an optional argument.
Syntax
<section begin="syntax" />%result = $ListNew(option) <section end="syntax" />
%result is set to the identifier of the created empty $list.
There are no error codes associated with $ListNew.
All invokatians 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.
Products authorizing $ListNew
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility