FindString

Top  Previous  Next

Searches the text plane for the target string. If found, returns an Position object containing the target location. If not found, returns a null. The TargetString must be completely contained by the target area for the search to be successful. Null characters in the text plane are treated as blank spaces during search processing.

 

VB.NET

 

[Position =] Screen.FindString(TargetString As String, startPos As Position, length As Integer, dir As OHIO_DIRECTION, IgnoreCase As Boolean)

 

C#

 

[Position =] Screen.FindString(string targetString, Position startPos, int length, int dir, bool ignoreCase);

 

 

Parameters

 

Parameter

Description

TargetString

The target string.

startPos

The row and column where to start. The position is inclusive (for example, row 1, col 1 means that position 1,1 will be used as the starting location and 1,1 will be included in the search).

length

The length from startPos to include in the search.

dir

An OHIO_DIRECTION value.

IgnoreCase

Indicates whether the search is case sensitive. True means that case will be ignored. False means the search will be case sensitive.