.WaitForEvent

Syntax

WaitForEvent EventType, "Timeout", "Duration", Row, Column

Description

Begins a wait that is satisfied by the occurrence of the specified event. The operation containing the command is paused until the event occurs or the timeout expires. If you specify a duration of time, Host Integrator will expect the event to last that long to satisfy the wait.

Command Parameters

Event Argument type: Enumeration
  The event for which to wait. The possible events are as follows:
  After data communication is silent rcSilence
  Waits for the absence of data traveling to or from the host. Use the Timeout argument to specify how long to wait for a period of silence, and Duration to specify how long that period must last.
   
  When a connection is made rcEvConnected
  Waits for a host connection. Use the Timeout argument to specify how long to wait for the connection to occur.
   
  When a connection is terminated rcEvDisconnected
  Waits for the lack of a host connection. Use the Timeout argument to specify how long to wait for the connection to be terminated.
   
  When a new host screen arrives NewHostScreen
  Defines an event as a new screen from the host.
   
  When the cursor enters a field rcEnterField
  Waits for the cursor to enter the specified field (as identified by the Row and Column arguments). Use the Timeout argument to specify how long to wait for the cursor to enter the field at the specified coordinates.
   
  When the cursor enters a position rcEnterPos
 

Waits for the cursor to reach specified screen coordinates (as identified by the Row and Column arguments). Use the Timeout argument to specify how long to wait for the cursor to reach the specified coordinates.

   
  When the cursor leaves a field rcExitField
  Waits for the cursor to exit the specified field (as identified by the Row and Column arguments). Use the Timeout argument to specify how long to wait for the cursor to exit the field at the specified coordinates.
   
  When the cursor leaves a position rcExitPos
  Waits for the cursor to be at any screen coordinates other than specified coordinates (as identified by the Row and Column arguments). Use the Timeout argument to specify how long to wait for the cursor to leave the specified coordinates.
   
  When the keyboard is enabled rcKbdEnabled
  Waits for the keyboard to be unlocked for the specified duration. Use the Timeout argument to specify how long to wait for the keyboard to be enabled, and Duration to specify how long the keyboard must remain enabled.
   
Timeout Argument type: String
  Specifies an interval of time in HH:MM:SS format. The wait terminates if this amount of time passes without the specified event occurring. If this method times out, an error occurs.
   
Duration Argument type: String
  Specifies an interval of time in HH:MM:SS format. The specified event must last this long to satisfy the wait.
   
Row

Argument type: Integer

 

This value is only relevant if event is set to rcEnterField, rcExitField, rcEnterPos, or rcExitPos. For the wait to be satisfied, the cursor must enter (or exit) the field at the specified row and column coordinates. If event is not set to rcEnterField, rcExitField, rcEnterPos, or rcExitPos, use 1 as the value of this argument. You can also use rcMouseRow to specify the row where the mouse was last clicked.

   
Column Argument type: Integer
  This value is only relevant if event is set to rcEnterField, rcExitField, rcEnterPos, or rcExitPos. For the wait to be satisfied, the cursor must enter (or exit) the field at the specified row and column coordinates. If event is not set to rcEnterField, rcExitField, rcEnterPos, or rcExitPos, use 1 as the value of this argument. You can use rcMouseCol to specify the column where the mouse was last clicked.