2.2.4.1.6.19 SetLamp
The SetLamp packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST cause the specified lamp to be set on the specified open phone device in the specified lamp mode.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
dwRequestID |
|||||||||||||||||||||||||||||||
|
hPhone |
|||||||||||||||||||||||||||||||
|
dwButtonLampID |
|||||||||||||||||||||||||||||||
|
dwLampMode |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
Reserved6 |
|||||||||||||||||||||||||||||||
|
Reserved7 |
|||||||||||||||||||||||||||||||
|
Reserved8 |
|||||||||||||||||||||||||||||||
|
Reserved9 |
|||||||||||||||||||||||||||||||
|
Reserved10 |
|||||||||||||||||||||||||||||||
Req_Func (4 bytes): The identifier of the function that will be invoked on the remote server. This value MUST be set to 115.
-
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_NOMEM
0x0000001A
PHONEERR_INVALBUTTONLAMPID
0x00000009
PHONEERR_RESOURCEUNAVAIL
0x0000001F
PHONEERR_INVALPHONESTATE
0x00000014
PHONEERR_OPERATIONFAILED
0x0000001C
PHONEERR_INVALLAMPMODE
0x00000011
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.
hPhone (4 bytes): An HPHONE. The handle to the phone whose lamp is to be set. This field MUST have been obtained by sending the Open packet.
dwButtonLampID (4 bytes): An unsigned 32-bit integer. The button whose lamp is to be set. 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.
dwLampMode (4 bytes): An unsigned 32-bit integer. Specifies how the lamp is to be lit. The dwLampMode parameter MUST have one of the PHONELAMPMODE_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.
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.