$ListNew: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
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 <var>$ListNew</var> function is the [[New (Stringlist constructor)]].</p>


This function creates an empty $list.  
This function creates an empty $list.  


The $ListNew function accepts one argument and returns a numeric result.  
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.
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.
Line 18: Line 18:
There are no error codes associated with $ListNew.  
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.<p>
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.<p>


<ul class="smallAndTightList">
<ul class="smallAndTightList">

Revision as of 19:25, 19 October 2012

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" />

$ListNew Function

%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.

Products authorizing $ListNew