WaitForHostSettle4 Method

In This Topic

Waits for host screen data to settle (that is, there is no incoming data for the specified settle time).

Syntax

Visual Basic (Declaration)

expression.WaitForHostSettle4( _
   ByVal settleTime As Integer, _
   ByVal timeout As Integer, _
   ByVal enablekeyboard As Boolean _
) As ReturnCode

where expression is a variable that represents a Screen Object

Parameters

settleTime: The settle time (in milliseconds).
timeout: wait timeout value (milliseconds). Value of 0 indicates wait indefinitely.
enablekeyboard: Specifies whether the keyboard is enabled while the call executes.

Return Value

One of the following ReturnCode enumeration values.

Member	Description
Cancelled	Cancelled.
Error	Error.
PermissionRequired	Permission is required.
Success	Success.
Timeout	Timeout condition.
Truncated	The text is truncated.

Remarks

The wait timeout value should be greater than settleTime.

Example

This example enters a command to navigate, waits a set time for the host to settle, and then gets some text on the screen.

Visual Basic

Sub ExampleForWaitforHostSettle4()
    Dim rcode As ReturnCode
    Dim text As String
    'Enter a command to navigate
    ThisScreen.SendKeys "demo"
    ThisScreen.SendControlKey ControlKeyCode_Enter
    
    'Make sure the screen is ready before entering commands
    rcode = ThisScreen.WaitForHostSettle4(3000, 4000, True)
    
    text = ThisScreen.GetText2(1, 1, ThisScreen.DisplayRows, ThisScreen.DisplayColumns)
    
    Debug.Print text
    
End Sub

Reference

Screen Object
Screen Members

Send Feedback