2.2.4.1.3.8 CompleteTransfer

The CompleteTransfer packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet completes the transfer of the specified call to the party that is connected in the consultation call. If dwTransferMode is LINETRANSFERMODE_CONFERENCE, the original call handle is changed to a conference call. Otherwise, the service provider SHOULD send call state packets to change the calls to idle.


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

lpContext

hCall

hConsultCall

lpConfCallContext

dwTransferMode

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

Reserved7

Reserved8

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 11.

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 as follows:

Name

Value

LINEERR_INVALCALLHANDLE

0x80000018

LINEERR_OPERATIONUNAVAIL

0x80000049

LINEERR_INVALCALLSTATE

0x8000001C

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_NOMEM

0x80000044

LINEERR_RESOURCEUNAVAIL

0x8000004B

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.

lpContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.

hCall (4 bytes): An HCALL. The handle to the call to be transferred. One way in which the client can obtain a valid hCall is from the LINE_CALLSTATE packet sent by the remote server.  The application MUST be an owner of this call. The call state of hCall must be onHold or onHoldPendingTransfer. For hCall to be in onHoldPendingTransfer state, the client needs to send SetUpTransfer packet to the remote server. For hCall to be in onHold state, the client needs to send Hold packet to the remote server.

hConsultCall (4 bytes): An HCALL. The handle to the call that represents a connection with the destination of the transfer. One way in which the client can obtain a valid hCall is from the LINE_CALLSTATE packet sent by the remote server. The application MUST be an owner of this call. The call state of hConsultCall MUST be connected, ringback, busy, or proceeding.

lpConfCallContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.

dwTransferMode (4 bytes): An unsigned 32-bit integer. Specifies how the initiated transfer request is to be resolved. This parameter MUST use one of the LINETRANSFERMODE_Constants.

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.