View Source

Syntax

anArray.concatArrays(anotherArray_1, ..., anotherArray_n)

Semantics Concatenates the elements of one or more arrays to the elements of anArray.

Substitutables anArray Can be any variable or object attribute having the type Array. The arrays must not be NULL.

Error Codes Find the related error codes on System Errors.

BESM/2

One of the parameters of a vararg function is null. This error occurs if one of the arrays is NULL.

Examples

set anArray = anArray.concatArrays(anotherArray);

A new array is created containing all references to elements of the listed arrays. The reference anArray is changed to point to the new array.

The figure below shows an example of concatenating several arrays in a new array and into an array with existing elements.

Figure: concatArray() Example

BRIDGE > concatArrays > concatArray.png

If the arrays to be concatenated (here array2 or array3) are empty (not NULL ), no exception occurs.
If an array has NULL elements (e.g. element1, element2, NULL, element4), the NULL elements will be preserved after concatenation.