2.2.4.1.6.14 SetButtonInfo
The SetButtonInfo packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST set information about the specified button on the specified phone.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
dwRequestID |
|||||||||||||||||||||||||||||||
|
hPhone |
|||||||||||||||||||||||||||||||
|
dwButtonLampID |
|||||||||||||||||||||||||||||||
|
lpButtonInfo |
|||||||||||||||||||||||||||||||
|
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 110.
-
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_INVALBUTTONLAMPID
0x00000009
PHONEERR_OPERATIONFAILED
0x0000001C
PHONEERR_NOMEM
0x0000001A
PHONEERR_OPERATIONUNAVAIL
0x0000001D
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. The service provider MUST return this value if the function completes asynchronously.
hPhone (4 bytes): An HPHONE. The handle to the phone for which button information is to be set. This field MUST have been obtained by sending the Open packet.
dwButtonLampID (4 bytes): An unsigned 32-bit integer. A button on the phone device. A valid value of dwButtonLampID is in the range 0 to dwNumButtonLamps –1. The client obtains dwNumButtonLamps from the PHONECAPS obtained by sending a GetDevCaps packet to the remote server.
lpButtonInfo (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field of a PHONEBUTTONINFO packet that describes the mode and function, and provides additional descriptive text about the button.
Reserved2 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved3 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved4 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved5 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved6 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved7 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved8 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved9 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
Reserved10 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
VarData (variable): MUST contain a PHONEBUTTONINFO packet.
-
The contents of this field are DWORD-aligned.