SearchMatch.GetLocation

Syntax

SearchMatch.GetLocation( matchElement, matchStart, matchLength)

Purpose

Returns the element of the property where the match was found and the location of the match within the property when the value is coerced to a string.

Remarks

Use the SearchMatch.MatchedText property to obtain the entire element value as a coerced string in which the match was found.

Parameters

matchElement As Long

[Out] Returns the element of the property in which the match was found. The value of this parameter is one of the SearchElements constants.

matchStart As Long

[Out] Returns the zero-based index within the string of the starting character location of the match. Use the SearchMatch.MatchedText property to obtain the entire string in which the match was found.

matchLength As Long

[Out] Returns the number of characters of the text that are part of the match.

See Also

SearchElements

SearchMatch.MatchedText

SearchResults