2.2.2 HANDLE TABLE

The following table lists the handle types that are used in the Telephony Remote Protocol and specifies how they are obtained and how they are released. All asynchronous events and completion packet packets have one or more handle parameters that are relevant to the corresponding event. The table lists only those packets with handle parameters that are new; that is, the handle was not provided to the client earlier.

The server is responsible for maintaining data structures internally that enable it to obtain the corresponding handle when an event or completion occurs and send the handle to the client.

 Obtained by

Handle type

 Name of packet

 Field in packet

Released by

HLINEAPP

Initialize

hLineApp

ShutDown

HLINE

Open

hLine

Close/LINE_CLOSE

HPHONEAPP

Initialize

hPhoneApp

ShutDown

HPHONE

Open

hPhone

Close/PHONE_CLOSE

HCALL

LINE_APPNEWCALL

Note This packet is sent only if the client has negotiated a TAPI version of 2.0, 2.1, 2.2, 3.0, and 3.1.

Param2

DeallocateCall

HCALL

LINE_CALLSTATE

Note Clients that have negotiated a TAPI version earlier than 2.0, need to examine if this packet is an "old" call (same handle as an already obtained valid call handle) or a new call (different from all existing valid call handles). For clients that negotiated a TAPI version of 2.0, 2.1, 2.2, 3.0, and 3.1, this will always be an "old" call because the handle would have already been sent through LINE_APPNEWCALL.

hCall

DeallocateCall

HCALL

CompleteTransfer

hConfCall

DeallocateCall

HCALL

Forward

hConsultCall

DeallocateCall

HCALL

MakeCall

hCall

DeallocateCall

HCALL

PickUp

hCall

DeallocateCall

HCALL

PrepareAddToConference

hConsultCall

DeallocateCall

HCALL

SetUpConference

hConfCall

DeallocateCall

HCALL

SetUpConference

hConsultCall

DeallocateCall

HCALL

SetUpTransfer

hConsultCall

DeallocateCall

HCALL

UnPark

hCall

DeallocateCall

HCALL

GetNewCalls

pCallList of type LINECALLLIST

DeallocateCall