Documentation ARexxAPI APPBUSY

APPBUSY

NAME:: AppBusy -- Switch YAM into busy state. (V2.0)

TEMPLATE:: TEXT

FUNCTION:: Switches YAM into busy state and optionally displays a short text in the status bar. During this state, YAM won't accept any input.

INPUTS:: TEXT - optional, a brief piece of text to display in the status bar while YAM is in busy state; the maximum length of the displayable text depends on the width of the characters used

RETURNS:: RC is set to 1 if YAM was already busy.

NOTES:: V2.4 introduced the concept of busy levels, meaning the command is now accumulative: if AppBusy is called several times, an equal number of calls to AppNoBusy must be made for the application to return to normal state.

EXAMPLE:: {{{#!arexx /* Turn busy mode on */ 'APPBUSY "Please wait..."'

 /* Say we are doing something different */
 'APPBUSY "Making coffee..."'

 /* Turn all busy modes off */
 APPNOBUSY
 APPNOBUSY
 }}}

BUGS::

SEE ALSO:: APPNOBUSY