2.2.4.1.6.3 GetData

The GetData packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST upload the information from the specified location in the open phone device to the specified packet.


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

hPhone

dwDataID

lpData

dwSize

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

Reserved7

Reserved8

Reserved9

Reserved10

VarData (variable)

...

Req_Func (4 bytes): The identifier of the function that will be invoked on the remote server. This value MUST be set to 94.

Return Values

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

Returns zero if the request succeeds or a negative error number if an error occurs. The following table lists common return values.

Name

Value

PHONEERR_INVALPHONEHANDLE

0x00000013

PHONEERR_NOMEM

0x0000001A

PHONEERR_INVALPOINTER

0x00000015

PHONEERR_RESOURCEUNAVAIL

0x0000001F

PHONEERR_INVALPHONESTATE

0x00000014

PHONEERR_OPERATIONFAILED

0x0000001C

PHONEERR_INVALDATAID

0x0000000C

PHONEERR_UNINITIALIZED

0x00000022

PHONEERR_OPERATIONUNAVAIL

0x0000001D

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

hPhone (4 bytes): An HPHONE. The handle to the open phone device. This field MUST have been obtained by sending the Open packet.

dwDataID (4 bytes): An unsigned 32-bit integer. Specifies from where in the phone device, the packet is to be uploaded. A valid value of dwDataID is in the range 0 to dwNumGetData – 1. The client obtains dwNumGetData from the PHONECAPS obtained by sending a GetDevCaps packet to the remote server.

lpData (4 bytes): An unsigned 32-bit integer. Set to TAPI_NO_DATA (0xFFFFFFFF). Upon successful completion of the request, this field contains the offset, in bytes, of the uploaded data in the VarData field.

dwSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the data packet.

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.

VarData (variable): This field MUST be present only on successful completion of the request and MUST contain the uploaded data on successful completion.

The contents of this field are DWORD-aligned.