Programming with Reflection

image\rwnprg32.gif WaitEventNumber method


Syntax Found = object.WaitEventNumber(Event, TimeOut, [Options])



Waits for the occurrence of the specified event, defined with the DefineEvent method. The procedure containing the command is paused until the wait expires or is satisfied.


Event Argument type: Integer
The event for which to check. The event number is assigned by the Event argument of DefineEvent.

TimeOut Argument type: String
Specifies an interval of time in HH:MM:SS.hh format. If this interval elapses before any events occur, an error occurs.

Options Argument type: Enumeration
Specifies additional, non-default behavior for the method. There is one option for this method:


 Specifies that the user is allowed to enter keystrokes in the terminal window during the wait.


Found Return type: Boolean
True if the specified event was satisfied, or False if the event was not satisfied before the method timed out.

Note: When a wait is satisfied, the status of the event is reset. Until the event is removed (using RemoveEvent or ClearEvents), it will be satisfied again after this point when the conditions of the defined event have once again been met.



image\jump.gif Example

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this command