KSALARM (Sound Alarm)

Purpose

Sounds alarm.

Syntax

#include <sys/inputdd.h>

int ioctl (FileDescriptor, KSALARM, Arg)
int  FileDescriptor;
struct ksalarm * Arg;

Description

The KSALARM ioctl subroutine call causes the native keyboard speaker to produce a sound using the specified frequency and duration. A valid frequency is 32Hz-12KHz inclusive. A valid duration is a number between 0 and 32767. Duration is specified in units of 1/128 of a second, with a maximum of 4.3 minutes.

If the alarm is already on, the request is queued and processed after the previous alarm request has completed. If the queue is full, an EBUSY error code is returned. The KSALARM function returns immediately if the alarm volume is off (KSAVOLOFF) or a duration of 0 is specified.

When keyboard diagnostics are enabled, the KSALARM ioctl subroutine call fails and sets the errno global variable to a value of EBUSY.

Parameters

Item Description
FileDescriptor Specifies the open file descriptor for the keyboard.
Arg Specifies the address of the KSALARM structure.