VirtualStringArray.BuildSingleString(String, Variable) Method

Top

Description

Returns a concatenation of the elements of the StringArray specified by numberOfElementsToProcess, delimited by the character sequence specified by delimiter.

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

VirtualStringArray.BuildSingleString(	String delimiter,
	Variable numberOfElementsToProcess)

Arguments

delimiter
Description:	User-specified character sequence to use as a delimiter in the concatenated string.

numberOfElementsToProcess
Description:	The number of elements to concatenate, starting from the 0th index. Must be less than or equal to the number of elements in the StringArray.
Valid Range:	numberOfElementsToProcess ≥ 0

Return Value

Type:

string

Returns a concatenation of the elements of the StringArray specified by numberOfElementsToProcess, delimited by the character sequence specified by delimiter.

Syntax

myString1 = {"Test1", "Test2"}.BuildSingleString(myString2, myVariable1);