WaitForText(Int32,String,Int32,Int32,Int32,Int32,TextComparisonOption) Method

In This Topic

Waits for the specified text to appear in the specified location.

Syntax

Visual Basic
C#

'Declaration
 
Overloads Function WaitForText( _
   ByVal timeout As Integer, _
   ByVal text As String, _
   ByVal startRow As Integer, _
   ByVal startColumn As Integer, _
   ByVal endRow As Integer, _
   ByVal endColumn As Integer, _
   ByVal option As TextComparisonOption _
) As ReturnCode

'Usage
 
Dim instance As IUtsScreen
Dim timeout As Integer
Dim text As String
Dim startRow As Integer
Dim startColumn As Integer
Dim endRow As Integer
Dim endColumn As Integer
Dim option As TextComparisonOption
Dim value As ReturnCode
 
value = instance.WaitForText(timeout, text, startRow, startColumn, endRow, endColumn, option)

ReturnCode WaitForText( 
   int timeout,
   string text,
   int startRow,
   int startColumn,
   int endRow,
   int endColumn,
   TextComparisonOption option
)

Parameters

timeout: Wait timeout value.
text: Text string.
startRow: Start row.
startColumn: Start column.
endRow: End row.
endColumn: End column.
option: TextComparisonOption indicates the desired text string comparison.

Return Value

ReturnCode indicates success, failure, or a warning condition.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Thrown if the startRow, endRow, startColumn, or endColumn parameters are outside the range of valid values: (1 to Rows) or (1 to Columns).

Reference

IUtsScreen Interface
IUtsScreen Members
Overload List

Send Feedback