Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminals Functions / Getting Information About Telephone Terminals

TELGetInfo

Gets information about a terminal and tool.

pascal TELErr TELGetInfo (TELHandle hTEL);

hTEL

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

function result

A result code.

DESCRIPTION

The TELGetInfo function returns, in the hTEL parameter, state and feature information about the telephone terminal and telephone tool specified by the hTEL parameter. The Telephone Manager passes the specified telephone record to the tool specified by the procID field of that record; that tool then inspects the terminal reference number (contained in the tRef field of telephone terminal record specified by the pTELTerm field of hTEL) and fills in the record with the appropriate information. The information returned by TELGetInfo is a snapshot of the current state of the telephone terminal and tool. That information may become stale as subsequent operations are performed on the terminal or tool.

If hTEL is invalid, TELGetInfo returns the result code telBadTermErr; in that case, you should dispose of the invalid telephone record by calling TELDispose.