Applies To Objects
Description
Waits until the cursor is at the specified location. The method will wait for the length of time set in System.TimeoutValue.
Syntax
object.WaitForCursor Row[,
Col][, EndRow][,
EndCol][, Page][,
Type]
-or-
rc
= object.WaitForCursor(Row[,
Col][, EndRow][,
EndCol][, Page][,
Type])
-or-
Set waitobj = WaitForCursor(Row[, Col][, EndRow][, EndCol][, Page][, Type])
Element |
Description |
object |
The Screen object. |
Row |
The row where you want the cursor to appear. |
Col |
The column where you want the cursor to appear. |
EndRow, EndCol |
If both these parameters are provided in the call, as well as Row and Col, the wait will be satisfied as soon as the cursor appears within the screen area defined by these parameters. |
Page |
VT session only -- the screen page. |
Type |
Reserved for future use. |
rc |
The return value for the second syntax from above. TRUE: Cursor is at the specified location within the time specified by System.TimeoutValue. FALSE: Time out occurred. |
Set |
The Set statement, required for assigning an object reference to a variable. |
waitobj |
The returned wait-type object. |
Comments
If either the first or second syntax form above is used, WaitForCursor will suspend execution of your macro or program, returning only when the cursor arrives at the specified location, or a timeout occurs. If the third syntax form is used, WaitForCursor 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, see help for the Waits object.