The SetBusy function allows a script to define whether the cursor changes to indicate that the script is running. This function is often used when scripts have to perform a process which can take an extended amount of time to complete—during this time, the cursor can change shape to a busy icon, indicating to the user that the script is running normally and that there is a delay before the script can run to completion.
|
Syntax |
SetBusy (Boolean) |
|
Description |
When True, causes the cursor to indicate that a script is busy running. |
|
Arguments |
SetBusy {Boolean} You have to set the Boolean value to True if the busy cursor is to be enabled; false if the busy cursor is to be disabled. |
|
Returns |
None. If the Boolean value is true, the cursor icon will change to indicate that a script is running; if the Boolean value is false, the cursor icon will remain the same irrespective of whether a script is running. |
Example:
SetBusy (True)
The cursor icon will change when the script is running so that users can identify that the script is running and has not yet run to completion.