$Arr_Init
Initialize every element of an array to specific value
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $Arr_Init function because the OO methods emphasize the use of Collections over the use of arrays.
$Arr_Init can be used to initialize every element of an array to a specific value.
Syntax
%result = $Arr_Init (array, value)
%result receives a 0 or, if the array is invalid, a -1.
The first argument is an array of string, float, or fixed values. This array can be a single or multi-dimensional array and must not be an array in an image.
The second argument is the value with which the array is to be initialized. If this argument is not specified, it defaults to a null string if the first argument is a string array and 0 if the first argument is either a fixed or float array.
For string array elements the value assigned to the second argument will be truncated if the value is longer than the element length.
Examples
- In the following example, every element of %FXARRAY is set to 0:
%FXARRAY IS FIXED ARRAY(5) %RC = $Arr_Init(%FXARRAY)
- In the following example, every element of %STARRAY is set to '*** UNKNOWN ***':
%STARRAY IS STRING LEN 20 ARRAY(5) %RC = $Arr_Init(%STARRAY, '*** UNKNOWN ***')