$ListNewAI

From m204wiki
Revision as of 22:58, 19 February 2015 by JALWiccan (talk | contribs) (Automatically generated page update)
Jump to navigation Jump to search

Create array of empty $lists associated with image

Note: Most Sirius $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.

Products authorizing $ListNewAI

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$ListNewAI&oldid=75933"