Inside Macintosh: Telephony /

Chapter 4 - Call Appearances / Call Appearance Reference

Call Appearance Functions / Parking and Picking Up Calls

TELParkCall

Parks a call, making it available for retrieval at another directory number.

pascal TELErr TELParkCall (
                     TELCAHandle hTELCA, 
                     StringPtr *parkRetrieveID, 
                     ConstStr255Param parkID);

hTELCA

A handle to the call appearance structure for the call you want to park. If you're parking an outgoing call, you get the handle from the TELSetupCall function (page 4-24) or, if the user manually initiated the call, from the telCAOutgoingMsg message. If you're parking an incoming call, you get the handle from either a telCAAlertingMsg message or a telCAOfferMsg message.

parkRetrieveID

The address of a string pointer. You should set the string pointer itself to nil. Some telephone systems require a user to enter an identifier at another directory number to retrieve the parked call. If the parkRetrieveWithID bit in the featureFlags field of the call appearance structure is set, the function allocates a buffer, places an identifier in it, and sets your string pointer to the buffer address. Your application is responsible for disposing of the buffer. If the parkRetrieveWithID bit is not set, the function ignores this parameter.

parkID

A pointer to a Pascal-style string containing an identifier, such as a directory number or code. Some telephone systems require the user to provide an identifier when parking a call and to enter it when retrieving the parked call at another directory number. If the parkWithGivenID bit in the featureFlags field in the call appearance structure is set, you must provide an identifier in this parameter. If the parkWithGivenID bit is not set, the function ignores this parameter.

function result

A result code.

DESCRIPTION

Some telephone systems require both kinds of identifiers. In that case, both the parkRetrieveWithID and parkWithGivenID bits in the featureFlags field of the call appearance structure are set.

Telephone systems that require the user to provide an identifier can define the format and length of a valid identifier--that is, the value of the parkID parameter cannot be any arbitrary value.

After your application calls TELParkCall, your call appearance message handler should receive the message telCACallParkMsg.