Set Array Length Method

The Set Array Length method sets the first index and length of an array. It sets the length of the array argument to a range that the minIndex argument and the length argument define.

If you specify all three arguments for this method, then the following occurs:

The minIndex argument is the minimum index of the resized array.
The length argument is the length of the resized array.
If an element resides outside the length of the resized array, then that element becomes undefined.

If you only specify two arguments, then this method uses the second argument as the length argument and sets the minimum index of the resized array to 0 by default.

This method is unique to Siebel eScript. For more information, see Make Sure the JavaScript Interpreter Can Run a Function.

Format

setArrayLength(array[length])

The following table describes the arguments for the Set Array Length method.

Argument	Description
array	The name of the array whose length this method must set.
length	The length of the array.

Use Caution If You Define an Array That Includes a Negative Index

Use caution if you defined an array that includes a negative index.

Caution: ST eScript code does not support a negative array index. If you define an array that includes a negative index, and if you use T eScript code to define this array in a Siebel application prior to release 7.8, then you must redefine the index range for this array and any references according to index values. As an alternative to using the Set Array Length method to set the array length, you can use the length property of the array object.

Format

Use Caution If You Define an Array That Includes a Negative Index

Related Topics