$ListNewAI: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(Automatically generated page update) |
||
| (23 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Create array of empty $lists associated with image</span> | <span class="pageSubtitle">Create array of empty $lists associated with image</span> | ||
<p class=" | <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 $ListNewAI 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. | ||
| Line 8: | Line 8: | ||
The <var>$ListNewAI</var> function accepts nine arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function. | The <var>$ListNewAI</var> function accepts nine arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">[%rc =] $ListNewAI(%array, image_id, option, start_dim1, - | ||
size_dim1, start_dim2, size_dim2, - | size_dim1, start_dim2, size_dim2, - | ||
start_dim3, size_dim3 ) | start_dim3, size_dim3 ) | ||
</p> | </p> | ||
<p | |||
<p>%rc is set to 0 or to an error indicator.</p> | |||
<ul> | <ul> | ||
| Line 21: | Line 20: | ||
<li>The third 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, 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 fourth 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 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 fifth 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 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 sixth 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 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 seventh 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 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 eighth 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 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 ninth 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 ninth 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=== | ||
<p class="code">0 - No errors | |||
1 - Invalid array bound | |||
</p> | </p> | ||
All invocations of a particular call to <var>$ListNewAI</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. | ==Usage notes== | ||
<ul> | |||
<li>All invocations of a particular call to <var>$ListNewAI</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. | |||
<var>$ListNewAI</var> performs the same processing as [[$ListNewA]] and a [[$ListImg]] call for each $list mapped to the array but does so in a single call. | <li><var>$ListNewAI</var> performs the same processing as [[$ListNewA]] and a [[$ListImg]] call for each $list mapped to the array but does so in a single call. | ||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<li>[[Sirius functions]]</li> | <ul class="smallAndTightList"> | ||
<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> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListNewAI]] | [[Category:$Functions|$ListNewAI]] | ||
Latest revision as of 22:51, 20 September 2018
Create array of empty $lists associated with image
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $ListNewAI function, but the feature is implemented in a much more natural way with Collections.
This function creates an array of empty $lists.
The $ListNewAI function accepts nine arguments and returns a numeric result. It is a callable $function.
Syntax
[%rc =] $ListNewAI(%array, image_id, 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 can either be a string containing the name of an image or any image item from the required image. This is a required argument.
- The third 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 fourth 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 fifth 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 sixth 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 seventh 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 eighth 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 ninth 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 $ListNewAI 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.
- $ListNewAI performs the same processing as $ListNewA and a $ListImg call for each $list mapped to the array but does so in a single call.