WaitForString2 Method

In This Topic

Waits for the specified text to be received from the host.

Syntax

Visual Basic (Declaration)

expression.WaitForString2( _
   ByVal text As String, _
   ByVal timeout As Integer _
) As ReturnCode

where expression is a variable that represents a Screen Object

Parameters

text: The text to wait for.
timeout: wait timeout value (milliseconds). Value of 0 indicates wait indefinitely.

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.

Example

This sample navigates to a screen and waits until a string is received from the host. The wait never times out. To run this sample, create a VT session with the connection type set to TelNet and the Host name/IP address field set to "unix:demo" and log in to the demo with any text

Visual Basic

'This sample navigates to a screen and waits until a string is received from the host.
Sub NavigateWithWaitForString2()
    Dim rcode As ReturnCode
    
    'a value of 0 specifies to never timeout
    Const NEVER_TIME_OUT = 0
    
    'Enter a command
    ThisScreen.SendKeys "demodata"
    ThisScreen.SendControlKey ControlKeyCode_Return
    
    'Wait for a string on the host screen before continuing and specify to never timeout
    rcode = ThisScreen.WaitForString2(LF & "Command> ", NEVER_TIME_OUT)
 
    If rcode = ReturnCode_Success Then
        'Continue with commands
    End If
End Sub

Reference

Screen Object
Screen Members

Send Feedback