StringArray.Insert(Variable, String) Method

Top

Description

Inserts the value of stringToInsert into the calling StringArray at the index specified by variableIndex, increasing the dimension of the StringArray by one. Indexing starts at zero, so if the variableIndex is 0, stringToInsert will be added as the first element in the StringArray.

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.Insert(	Variable variableIndex,
	String stringToInsert)

Arguments

variableIndex
Description:	The index at which to insert the value.
Valid Range:	variableIndex ≥ 0

stringToInsert
Description:	The string value to insert.

Return Value

Type:

number

Returns the new dimension of StringArray.

Syntax

myVariable1 = myStringArray1.Insert(myVariable2, myString1);