Available with host type: V
Applies to Objects: Area
Description
Waits for text in the portion of the screen defined by the Area object to change.
Syntax
object.WaitUntilChanged [Timeout]
-or-
rc = object.WaitUntilChanged ([Timeout])
-or-
Set waitobj = object.WaitUntilChanged([Timeout])
|
Element |
Description |
|---|---|
|
object |
The Area object. |
|
Timeout |
A number of milliseconds which can be provided to override the System.TimeoutValue for this call only. |
|
rc |
The return value. TRUE if area text changed before the Timeout (or System.TimeoutValue) was reached, FALSE if a timeout occurred while waiting. |
|
rc |
The return value. TRUE if area text changed before the Timeout (or System.TimeoutValue) was reached, FALSE if a timeout occurred while waiting. |
|
Set |
The Set statement, required for assigning an object reference to a variable. |
|
waitobj |
A wait-type object. |
Comments
When either of the first two syntax forms above is used, WaitUntilChanged will suspend execution of your macro or program (i.e. wait) until the text in the portion of the screen defined by the Area object changes, or a timeout occurs. If the third form is used, WaitUntilChanged will return immediately and the wait-type object returned can be used with the Waits collection, which allows several separate events to be monitored simultaneously. For more information on this, see help for the Waits object.