Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminals Functions / Monitoring and Controlling Telephone Terminals

TELGetHooksw

Gets the state of a terminal's hookswitch.

pascal TELErr TELGetHooksw (
                     TELHandle hTEL, 
                     short hookType, 
                     Boolean *offHook);

hTEL

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

hookType

The type of hookswitch. See "Hookswitch Types and States" on page 2-11 for a description of the available hookswitch types.

offHook

On exit, a Boolean value that indicates the hookswitch state of the specified terminal.

function result

A result code.

DESCRIPTION

The TELGetHooksw function returns, in the offHook parameter, a Boolean value that indicates whether the specified type of hookswitch of the terminal specified by the hTEL parameter is physically off hook (telDeviceOffHook) or on hook (telDeviceOnHook).