Array.Erase(Variable) Method

Top 

Description

Removes the element specified by variableIndex from the Array, decreasing the dimension of the Array by one.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

Array.Erase(

Variable variableIndex)

 

 

Arguments

variableIndex


Description:

Index to be removed from the Array. This value can range from 0 to Array.Dimension-1.

Valid Range:

variableIndex ≥ 0

 

 

 

Return Value

Type:

number

 

 

Returns the new dimension of Array.

 

Syntax

myVariable1 = myArray1.Erase(myVariable2);

 

 

See also

Array Object

Matrix, Array, and Variable Math Guide