Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminals Functions / Monitoring and Controlling Telephone Terminals

TELGetVolume

Gets the volume and state of a terminal device.

pascal TELErr TELGetVolume (
                     TELHandle hTEL, 
                     short volType, 
                     short *level, 
                     short *volState);

hTEL

A handle to a telephone record associated with a telephone terminal.

volType

The type of terminal device. See "Volume Controls" on page 2-12 for a description of the device types that have a volume and state.

level

On exit, a value that indicates the current volume level of the specified terminal device.

volState

On exit, a value that indicates the current volume state of the specified terminal device. See "Volume Controls" on page 2-12 for a description of the available volume states.

function result

A result code.

DESCRIPTION

The TELGetVolume function returns, in the level and volState parameters, the current volume level and state of the terminal device specified by the volType and hTEL parameters. The value returned in the level parameter is always between telVolMin and telVolMax. The value returned in the volState parameter is either telVolStateOn or telVolStateOff.