Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiGetAttention

hiGetAttention( 
[ x_loudness ]
) 
=> t / nil 

Description

Rings the bell in the keyboard or terminal.

Arguments

x_loudness

Overrides the loudness of the beep for that iteration. x_loudness ranges from -100 (silence) to 100 (full volume).

The default is zero. Setting x_loudness to zero causes the beep to be at the system default loudness. The absolute value of a negative number is the percentage from the system default loudness toward silence, and a positive number is the percentage from the system default loudness toward full volume. The amount of loudness control is system dependent. For example, Sun systems have the same volume for values -99 through 100, but HP systems have a wide range of volume.

Values Returned

t

There was no error.

nil

An error message is issued.

Related Topics

General Environmental Functions


Return to top
 ⠀
X