2.2.4.1.6.15 SetData
The SetData packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST download the information in the specified packet to the opened phone device at the selected data identifier.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
dwRequestID |
|||||||||||||||||||||||||||||||
|
hPhone |
|||||||||||||||||||||||||||||||
|
dwDataID |
|||||||||||||||||||||||||||||||
|
lpData |
|||||||||||||||||||||||||||||||
|
dwSize |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
Reserved6 |
|||||||||||||||||||||||||||||||
|
Reserved7 |
|||||||||||||||||||||||||||||||
|
Reserved8 |
|||||||||||||||||||||||||||||||
|
Reserved9 |
|||||||||||||||||||||||||||||||
|
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 111.
-
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 PHONEERR_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 PHONE_REPLY packet is 0 if the function succeeds, or 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. The following table lists common return values.
-
Name
Value
PHONEERR_INVALPHONEHANDLE
0x00000013
PHONEERR_RESOURCEUNAVAIL
0x0000001F
PHONEERR_INVALDATAID
0x0000000C
PHONEERR_OPERATIONFAILED
0x0000001C
PHONEERR_INVALPHONESTATE
0x00000014
PHONEERR_OPERATIONUNAVAIL
0x0000001D
PHONEERR_NOMEM
0x0000001A
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.
hPhone (4 bytes): An HPHONE. The handle to the phone into which data is to be downloaded. This field MUST have been obtained by sending the Open packet.
dwDataID (4 bytes): An unsigned 32-bit integer. Specifies where in the phone device the packet is to be downloaded. A valid value of dwDataID is in the range 0 to dwNumSetData –1. The client obtains dwNumSetData from the PHONECAPS obtained by sending a GetDevCaps packet to the remote server.
lpData (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field of the data to upload into the phone device.
dwSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the data indicated in the lpData 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.
VarData (variable): Contains the data to upload into the phone device. The format of the data, its meaning to the phone device, and the meaning of the data identifier are specific to the service provider.
The contents of this field are DWORD-aligned.