$ListNewA: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
(Automatically generated page update)
 
(35 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">Create array of empty $lists</span>
<span class="pageSubtitle">Create array of empty $lists</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $ListNewA function, but the feature is implemented in a much more natural way with [[Collections]].</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $ListNewA function, but the feature is implemented in a much more natural way with [[Collections]].</p>


This function creates an array of empty $lists.  
This function creates an array of empty $lists.  


The $ListNewA function accepts eight arguments and returns a numeric result. It is a [[Janus Sockets $functions#CALLing Sirius Mods $functions|callable]] $function.
The <var>$ListNewA</var> function accepts eight arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> [%RC =] $ListNewA(%array, option, start_dim1, size_dim1, -
<p class="syntax">[%rc =] $ListNewA(%array, option, start_dim1, size_dim1, -
               start_dim2, size_dim2, start_dim3, size_dim3)
               start_dim2, size_dim2, start_dim3, size_dim3)
<section end="syntax" /></p>
<p class="caption">$ListNewA Function
</p>
</p>
<p class="caption">%RC is set to 0 or to an error indicator.</p>
<p>%rc is set to 0 or to an error indicator.</p>


<ul>
<ul>
<li>The first argument is the array which will contain the identifiers of the $lists which are created. This is a required argument.  
<li>The first argument is the array which will contain the identifiers of the $lists which are created. This is a required argument.  
<li>The second argument, if set to the string <tt>NOREL</tt>, indicates that the contents of the $lists are not to be emptied when a RELEASE ALL RECORDS statement is executed. This is an optional argument.  
<li>The second argument, if set to the string <tt>NOREL</tt>, indicates that the contents of the $lists are not to be emptied when a RELEASE ALL RECORDS statement is executed. This is an optional argument.  
<li>The third argument is the start index for the created $list identifiers in the first dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the first dimension of the array.  
<li>The third argument is the start index for the created $list identifiers in the first dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the first dimension of the array.  
<li>The fourth argument is the number of indices for the created $list identifiers in the first dimension of the array. This is an optional argument; its default is the number of indices in the first dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.  
<li>The fourth argument is the number of indices for the created $list identifiers in the first dimension of the array. This is an optional argument; its default is the number of indices in the first dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.  
<li>The fifth argument is the start index for the created $list identifiers in the second dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the second dimension of the array.  
<li>The fifth argument is the start index for the created $list identifiers in the second dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the second dimension of the array.  
<li>The sixth argument is the number of indices for the created $list identifiers in the second dimension of the array. This is an optional argument; its default is the number of indices in the second dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.  
<li>The sixth argument is the number of indices for the created $list identifiers in the second dimension of the array. This is an optional argument; its default is the number of indices in the second dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.  
<li>The seventh argument is the start index for the created $list identifiers in the third dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the third dimension of the array.  
<li>The seventh argument is the start index for the created $list identifiers in the third dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the third dimension of the array.  
<li>The eighth argument is the number of indices for the created $list identifiers in the third dimension of the array. This is an optional argument; its default is the number of indices in the third dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.
<li>The eighth argument is the number of indices for the created $list identifiers in the third dimension of the array. This is an optional argument; its default is the number of indices in the third dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.
</ul>
</ul>


<p class="code">  
===Return codes===
0 - No errors
<p class="code">0 - No errors
1 - Invalid array bound
1 - Invalid array bound
</p>
<p class="caption">$ListNewA return codes
</p>
</p>


All invocations of a particular call to $ListNewA will always set the same values to those elements of the array that are being set. Each time that call is executed, any previous $lists in those elements created by that call are deleted, and a new list is created.  
==Usage notes==
<ul>
<li>All invocations of a particular call to <var>$ListNewA</var> will always set the same values to those elements of the array that are being set. Each time that call is executed, any previous $lists in those elements created by that call are deleted, and a new list is created.  


$ListNewA performs the same processing as [[$ListNew]], but it allows the creation of multiple lists in one call, and it allows you to manage the lists in an array. For example:
<li><var>$ListNewA</var> performs the same processing as [[$ListNew]], but it allows the creation of multiple lists in one call, and it allows you to manage the lists in an array. For example:
<p class="code"> B
<p class="code">B
%I FLOAT
%I FLOAT
%X FLOAT
%X FLOAT
%Y FLOAT
%Y FLOAT
%L FLOAT ARRAY(10)
%L FLOAT ARRAY(10)
%X = $READ('Number of procs to display, up to 10')
%X = $READ('Number of procs to display, up to 10')
%Y = $ListNewA(%L, , 1, %X)
%Y = $ListNewA(%L, , 1, %X)
IF %Y NE 0 THEN
IF %Y NE 0 THEN
    PRINT 'Error ' %X ' creating ' %X 'lists'
  PRINT 'Error ' %X ' creating ' %X 'lists'
    STOP
  STOP
END IF
END IF
FOR %I FROM 1 TO %X
FOR %I FROM 1 TO %X
    %Y = $ProcOpn($READ('Enter proc name'))
  %Y = $ProcOpn($READ('Enter proc name'))
    %Y = $ProcDat(%L(%I))
  %Y = $ProcDat(%L(%I))
END FOR
END FOR
PRINT 'Here are the procs, last requested first:'
PRINT 'Here are the procs, last requested first:'
FOR %I FROM %X TO 1 BY -1
FOR %I FROM %X TO 1 BY -1
    PRINT ' '
  PRINT ' '
    PRINT 'Proc number ' %I
  PRINT 'Proc number ' %I
    FOR %Y FROM 1 TO $ListCnt(%L(%I))
  FOR %Y FROM 1 TO $ListCnt(%L(%I))
      PRINT $ListInf(%L(%I), %Y)
      PRINT $ListInf(%L(%I), %Y)
    END FOR
  END FOR
END FOR
END FOR
</p>
</p>
</ul>


<p class="code">
==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Janus Open Client]]</li>
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
<li>[[Janus Open Server]]</li>
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>[[Janus Web Server]]</li>
<li>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
</ul>
</ul>
</p>
<p class="caption">Products authorizing $ListNewA
</p>


[[Category:$Functions|$ListNewA]]
[[Category:$Functions|$ListNewA]]

Latest revision as of 22:51, 20 September 2018

Create array of empty $lists

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $ListNewA function, but the feature is implemented in a much more natural way with Collections.

This function creates an array of empty $lists.

The $ListNewA function accepts eight arguments and returns a numeric result. It is a callable $function.

Syntax

[%rc =] $ListNewA(%array, option, start_dim1, size_dim1, - start_dim2, size_dim2, start_dim3, size_dim3)

%rc is set to 0 or to an error indicator.

  • The first argument is the array which will contain the identifiers of the $lists which are created. This is a required argument.
  • The second argument, if set to the string NOREL, indicates that the contents of the $lists are not to be emptied when a RELEASE ALL RECORDS statement is executed. This is an optional argument.
  • The third argument is the start index for the created $list identifiers in the first dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the first dimension of the array.
  • The fourth argument is the number of indices for the created $list identifiers in the first dimension of the array. This is an optional argument; its default is the number of indices in the first dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.
  • The fifth argument is the start index for the created $list identifiers in the second dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the second dimension of the array.
  • The sixth argument is the number of indices for the created $list identifiers in the second dimension of the array. This is an optional argument; its default is the number of indices in the second dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.
  • The seventh argument is the start index for the created $list identifiers in the third dimension of the array. This is an optional argument; its default is 1. It must be between 1 and the size of the third dimension of the array.
  • The eighth argument is the number of indices for the created $list identifiers in the third dimension of the array. This is an optional argument; its default is the number of indices in the third dimension of the array minus the start index, minus 1 (that is, all of the indices starting with the start index). It must be between 1 and this default value.

Return codes

0 - No errors 1 - Invalid array bound

Usage notes

  • All invocations of a particular call to $ListNewA will always set the same values to those elements of the array that are being set. Each time that call is executed, any previous $lists in those elements created by that call are deleted, and a new list is created.
  • $ListNewA performs the same processing as $ListNew, but it allows the creation of multiple lists in one call, and it allows you to manage the lists in an array. For example:

    B %I FLOAT %X FLOAT %Y FLOAT %L FLOAT ARRAY(10) %X = $READ('Number of procs to display, up to 10') %Y = $ListNewA(%L, , 1, %X) IF %Y NE 0 THEN PRINT 'Error ' %X ' creating ' %X 'lists' STOP END IF FOR %I FROM 1 TO %X %Y = $ProcOpn($READ('Enter proc name')) %Y = $ProcDat(%L(%I)) END FOR PRINT 'Here are the procs, last requested first:' FOR %I FROM %X TO 1 BY -1 PRINT ' ' PRINT 'Proc number ' %I FOR %Y FROM 1 TO $ListCnt(%L(%I)) PRINT $ListInf(%L(%I), %Y) END FOR END FOR

Products authorizing $ListNewA