SETBUSY Function

RAMP-TS

SETBUSY Function

Enables/Disables the system busy state. When SETBUSY is set to true, the status light will change to red and all user interactions are ignored.

 

Syntax

SETBUSY(fState) 

 

Parameters

fState

Required. A boolean value that indicates whether the system should go into the busy state.

 

 

Return Value

None

 

Remarks

Setting SETBUSY(true) indicates that:

  • The system is busy doing something
  • Things the user does should be ignored while the system is busy.
  • There is nothing the user can or should do to release the busy state - it will be released automatically when the busy activity completes.

It should not be enabled when interaction is required from the user.

If a script sets busy to true, it should ensure that it is set to false after the processing is finished. Otherwise the user will not be able to interact with the aXes screen.

 

Example

Turn off the busy state to allow user interaction, and indicate that the system is not busy

 

SETBUSY(false);

 

 

Turn on the busy state to ignore user interaction, and indicate that the system is busy

 

SETBUSY(true);