SubString(String, Variable, Variable) Function

Top

Description

Takes a portion of the source string stringArgument with a defined beginning (start) and length (numChars).

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.

Function Signature

SubString(	String stringArgument,
	Variable start,
	Variable numChars)

Arguments

stringArgument
Description:	The source string from which a substring will be extracted.

start
Description:	The index of the first character from which to begin the extraction (zero based).
Valid Range:	start ≥ 0

numChars
Description:	The number of characters to extract from the source string.
Valid Range:	numChars ≥ 0

Return Value

Type:

string

Return a substring of a string.

Syntax

myString1 = SubString(myString2, myVariable1, myVariable2);