Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminals Functions / Monitoring and Controlling Telephone Terminals

TELSetHooksw

Sets the state of a terminal's hookswitch.

pascal TELErr TELSetHooksw (
                     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

A Boolean value that indicates the new hookswitch state of the specified terminal.

function result

A result code.

DESCRIPTION

The TELSetHooksw function sets the state of the hookswitch of the terminal specified by the hTEL and hookType parameters to the state specified by the offHook parameter. If offHook is telDeviceOffHook, the hookswitch is taken off hook. If offHook is telDeviceOnHook, the hookswitch is put on hook.

SPECIAL CONSIDERATIONS

Some terminals might not support the TELSetHooksw function.