2.2.4.1.3.29 GetCallHubTracking

  • Article

The GetCallHubTracking packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet returns the current state of call-hub tracking for the service provider. This function requires TAPI 3.0 or 3.1 version negotiation.


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

hLine

lpTrackingInfo

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

Reserved7

Reserved8

Reserved9

Reserved10

Reserved11

Reserved12

VarData (20 bytes, optional)

...

...

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

Return Values

On completion of ClientRequest, this field contains the result of the encapsulated telephony request. A value of 0 indicates success, and a LINEERR_Constants value indicates failure. The remote server MUST complete this call synchronously.

MUST return zero if the function succeeds or an error number if an error occurs. Common return values are as follows:

Name

Value

LINEERR_INVALCALLHANDLE

0x80000018

LINEERR_NOMEM

0x80000044

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_OPERATIONUNAVAIL

0x80000049

LINEERR_RESOURCEUNAVAIL

0x8000004B

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

hLine (4 bytes): An HLINE. The handle to the open line device. This field MUST have been obtained by sending the Open packet.

lpTrackingInfo (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a LINECALLHUBTRACKINGINFO packet that is filled with call-related information upon successful completion of the request.

On successful completion, this field contains the offset, in bytes, of the packet in the VarData field.

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.

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

VarData (20 bytes): Present on successful completion of the request. Contains a LINECALLHUBTRACKINGINFO packet.

The contents of this field MUST be DWORD-aligned, as specified in [MS-DTYP] section 2.2.9.