WaitForText1 Method

In This Topic

Waits for the specified text to appear at the specified screen location. TextComparisonOption indicates desired text string comparison.

Syntax

Visual Basic (Declaration)

expression.WaitForText1( _
   ByVal timeout As Integer, _
   ByVal text As String, _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal options As TextComparisonOption _
) As ReturnCode

where expression is a variable that represents a IbmScreen Object

Parameters

timeout: Wait timeout value in milliseconds.
text: Text string.
row: Row position.
column: Column position.
options: A TextComparisonOption value.

Return Value

One of the following ReturnCode enum values.

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

Exceptions

Exception	Description
ArgumentOutOfRangeException	This exception is thrown if the row or column parameters are outside the range of valid values: (1 to Rows) or (1 to Columns).

Example

This sample uses the WaitForText1 method to navigate to a the "Edit - Entry Panel" Screen on the Reflection IBM3270 demo and writes some text on the last screen. To run this sample, create a 3270 session and set the Host name / IP address to demo:ibm3270.sim. Then paste this code into a VBA module and run the macro from the login screen.

Visual Basic

Sub NavigateWithWaitForText1()
    'Declare application, terminal, and view object variables:
    Dim terminal As Attachmate_Reflection_Objects_Emulation_IbmHosts.IbmTerminal
 
    Set terminal = ThisIbmTerminal
  
    'Get a handle to the Screen object and navigate to the screen we
    'want to enter the data on
    Set screen = terminal.screen
  
    'Navigate to the screen
    rcode = screen.SendControlKey(ControlKeyCode_Transmit)
    
    rcode = screen.WaitForText1(2000, "LOGON", 1, 1, TextComparisonOption_MatchCase)
    rcode = screen.SendKeys("ISPF")
    rcode = screen.SendControlKey(ControlKeyCode_Transmit)
  
    rcode = screen.WaitForText1(2000, "OPTION", 2, 2, TextComparisonOption_MatchCase)
    rcode = screen.SendKeys("2")
    rcode = screen.SendControlKey(ControlKeyCode_Transmit)
  
    rcode = screen.WaitForText1(2000, "COMMAND", 2, 2, TextComparisonOption_MatchCase)
      
    'Put some text into a field on the last screen
    rcode = screen.PutText2("Finished", 5, 18)
   
End Sub

Reference

IbmScreen Object
IbmScreen Members

Send Feedback