StringArray.Erase(Variable) Method

Top 

Description

Removes the element specified by variableIndex from the StringArray, decreasing the dimension of the StringArray 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

StringArray.Erase(

Variable variableIndex)

 

 

Arguments

variableIndex


Description:

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

Valid Range:

variableIndex ≥ 0

 

 

 

Return Value

Type:

number

 

 

Returns the new dimension of StringArray.

 

Syntax

myVariable1 = myStringArray1.Erase(myVariable2);

 

 

See also

StringArray Object

Parsing Arbitrary String Data