StringArray.Find(String, Array) Method

Top 

Description

Searches each element of the calling StringArray for an exact match of the stringToFind, storing the indices of the matched elements in an Array.

 

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.Find(

String stringToFind,


Array indicesArray)

 

 

Arguments

stringToFind


Description:

The string or character to find in the calling StringArray.

 

 

indicesArray


Description:

Used to store the indices of the elements that match the stringToFind argument.

 

 

 

Return Value

Type:

number

 

 

Returns the number of instances of the specified stringToFind that were found in the calling StringArray. Also stores the indices of the matched elements in the indicesArray argument. Returns 0 if stringToFind is not found in the calling StringArray.

 

Syntax

myVariable1 = myStringArray1.Find(myString1, myArray1);

 

 

See also

StringArray Object

StringArray.Find

Parsing Arbitrary String Data