Inside Macintosh: Telephony /

Chapter 4 - Call Appearances / Call Appearance Reference

Call Appearance Functions / Getting Information About Call Appearances

TELGetCAState

Retrieves the current state of a call appearance and updates the caState field of its call appearance structure to reflect that state.

pascal TELErr TELGetCAState (TELCAHandle hTELCA, short *state);

hTELCA

A handle to the call appearance structure. You provide the handle.

state

A pointer to your state variable. The function returns the current state of the call appearance in your state variable. See "Call Appearance States" (page 4-10) for descriptions of the states.

function result

A result code. If you provide an invalid handle, the function returns the telBadCAErr result code.

DESCRIPTION

The TELGetCAState function returns, through the state parameter, the current state of the call appearance specified by the hTELCA parameter. In addition, TELGetCAState updates the caState field of the call appearance structure. The information in the updated structure reflects the state of the call appearance at the time the Telephone Manager retrieves the information from the telephone tool.

Typically, you do not need to call the TELGetCAState function. When a telephone tool changes the state of a call appearance, it sends your call appearance message handler an appropriate message. In general, you should design your application to be message-driven.

SEE ALSO

The TELGetCAInfo function (page 4-54) also updates the caState field of a call appearance structure.