Applies To Objects
Description
Waits until the cursor has moved the specified number of rows and columns from its current position. The method will wait for the length of time set in System.TimeoutValue.
Syntax
object.WaitForCursorMove [NumOfRows][,
NumOfCols][, Page][,
Idle]
-or-
rc
= object.WaitForCursorMove([NumOfRows][,
NumOfCols][, Page][,
Idle] )
-or-
Set waitobj = object.WaitForCursorMove([NumOfRows][, NumOfCols][, Pages][, Idle])
Element |
Description |
object |
The Screen object. |
NumOfRows |
The number of rows to move. |
NumOfCols |
The number of columns to move. |
Page |
VT session only -- the number of screen pages to move. |
Idle |
Reserved for future use. |
rc |
Return value for second syntax form above: TRUE if the cursor has moved the specified amount within the time specified by System.TimeoutValue, otherwise FALSE (timeout occurred while waiting). |
Set |
The Set statement, required for assigning an object reference to a variable. |
waitobj |
A wait-type object. |
Comments
If optional parameters NumOfRows and NumOfCols are not provided in the call, any movement of the cursor will satisfy the wait.
When the first or second syntax form above is used, WaitForCursorMove will suspend execution of your macro or program until the cursor moves the specified number of rows or columns, or a timeout occurs. If the third form is used, WaitForCursorMove 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.