String.Merge(String, String, Variable) Method

Top

Description

Returns a "Merged" form of the calling String based on the specified regular expression. The merge is a replacement of the text matched by the regular expression with the value of the second argument.

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

String.Merge(	String regularExpression,
	String replacementString,
	Variable replaceOption)

Arguments

regularExpression
Description:	A regular expression that defines the pattern to search for when merging strings.

replacementString
Description:	String to use in place of the text matched by the regular expression.

replaceOption
Description:	Replace first match (replaceOption should be 0) or all matches (replaceOption should be 1).
Valid Range:	0 ≤ replaceOption ≤ 1

Return Value

Type:

string

Returns a "Merged" form of the calling String based on the regular expression specified by regularExpression. The merge is a replacement of the text matched by the regular expression with the value of replacementString.

Syntax

myString1 = myString2.Merge(myString3, myString4, myVariable1);