2.2.4.1.3.80 UnCompleteCall

The UnCompleteCall packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST cancel the specified call completion request on the specified line.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Req_Func

Reserved1

dwRequestID

hLine

dwCompletionID

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

Reserved7

Reserved8

Reserved9

Reserved10

Reserved11

Req_Func (4 bytes): An unsigned 32-bit integer. The identifier of the function that will be invoked on the remote server. This value MUST be set to 88.

Return Values

On completion of ClientRequest, this field MUST contain the result of the encapsulated telephony request. A nonzero request ID value indicates that the request is in progress and will complete asynchronously, and a LINEERR_Constants value indicates synchronous failure.

Returns a positive request identifier if the function will be completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY packet is zero if the function succeeds, or it is a negative error number if an error occurs. If the client specified a nonzero value in the dwRequestID field of the packet, the same value MUST be used for the returned positive request identifier. Common return values are:

Name

Value

LINEERR_INVALLINEHANDLE

0x8000002B

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_INVALCOMPLETIONID

0x8000001F

LINEERR_RESOURCEUNAVAIL

0x80000049

LINEERR_NOMEM

0x80000044

LINEERR_UNINITIALIZED

0x80000050

LINEERR_OPERATIONUNAVAIL

0x80000049

Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.

dwRequestID (4 bytes): An unsigned 32-bit integer. The identifier of the asynchronous request.

Value

Meaning

0x00000000

An unsigned 32-bit integer. The server MUST generate a unique positive request ID to return as the Ack_ReturnValue.

0x00000001 — 0x7FFFFFFF

The server MUST use this value instead of generating a unique positive request ID.

hLine (4 bytes): An HLINE. The handle to the line device on which a call completion is to be canceled. This field MUST have been obtained by sending the Open packet.

dwCompletionID (4 bytes): An unsigned 32-bit integer. The completion identifier for the request that is to be canceled. This value is obtained by sending a CompleteCall request to the remote server.

Reserved2 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved3 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved4 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved5 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved6 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved7 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved8 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved9 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved10 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved11 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.