Inside Macintosh: Telephony /

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminals Functions / Monitoring and Controlling Telephone Terminals

TELGetDisplay

Gets the text displayed on a terminal and the display mode of the terminal.

pascal TELErr TELGetDisplay (
                     TELHandle hTEL, 
                     short index, 
                     short *displayMode, 
                     StringPtr *text);

hTEL

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

index

A value the indicates which item of the displayed text to get. See "Display Items" on page 2-11 for a description of the available display items.

displayMode

On exit, the current display mode of the specified terminal. See "Display Modes" on page 2-10 for a description of the available display modes.

text

On exit, a pointer to a Pascal-style string that contains the text of the specified item on the display of the specified terminal. Your application is responsible for disposing of that string.

function result

A result code.

DESCRIPTION

The TELGetDisplay function returns, in the text parameter, a pointer to the text of the display item specified by the index parameter on the terminal specified by the hTEL parameter. TELGetDisplay also returns, in the displayMode parameter, the current display mode of the specified terminal.