VirtualString.Match(String, StringArray) Method

Top

Description

Returns the number of regular expression matches between the calling String and the specified String argument. In order to return a match, the String argument must match the entire string - this can be accomplished using regular expressions. A successful pattern match always returns >= 1, where multiple matches come from user specified groupings.

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

VirtualString.Match(	String regularExpression,
	StringArray stringArrayArgument)

Arguments

regularExpression
Description:	A regular expression that defines the pattern to match against.

stringArrayArgument
Description:	StringArray to hold the values of any groupings that match the regular expression.

Return Value

Type:

number

Returns the number of regular expression matches between the calling String and the regular expression specified by regularExpression.

Syntax

myVariable1 = myString1.ToLowercase().Match(myString2, myStringArray1);