alarm Parameter

Sounds the alarm on the next screen refresh.

Scope: Global

Syntax

query alarm 
set alarm { on | off | inverse } 

Options

on 
Sounds the alarm after the next refresh.
off 
Does not sound the alarm after the next refresh. This is the default value.
inverse 
Toggles between on and off.

Description

The alarm on parameter sounds an alarm when the screen is next refreshed (for example, when the current macro ends or after an sshow command). The alarm parameter is then automatically set to off after the screen has been refreshed. The alarm sounds only if beep is set to on.

Examples

  1. To see the state of the alarm parameter, type:
    query alarm 
  2. To turn the refresh alarm on, type:
    set alarm on 

API Return Code

-2 
The option you specified was not on, off, or inverse. Issue the set command again using one of these options.

alarm Command
beep Parameter
beeptone Parameter
beeplength Parameter