2.2.4.1.6.8 GetLamp
The GetLamp packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST return the current lamp mode of the specified lamp.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
hPhone |
|||||||||||||||||||||||||||||||
|
dwButtonLampID |
|||||||||||||||||||||||||||||||
|
lpdwLampMode |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
Reserved6 |
|||||||||||||||||||||||||||||||
|
Reserved7 |
|||||||||||||||||||||||||||||||
|
Reserved8 |
|||||||||||||||||||||||||||||||
|
Reserved9 |
|||||||||||||||||||||||||||||||
|
Reserved10 |
|||||||||||||||||||||||||||||||
|
Reserved11 |
|||||||||||||||||||||||||||||||
Req_Func (4 bytes): The identifier of the function that will be invoked on the remote server. This value MUST be set to 101.
-
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 0 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_INVALBUTTONLAMPID
0x00000009
PHONEERR_RESOURCEUNAVAIL
0x0000001F
PHONEERR_INVALPOINTER
0x00000015
PHONEERR_OPERATIONFAILED
0x0000001C
PHONEERR_INVALPHONESTATE
0x00000014
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.
dwButtonLampID (4 bytes): An unsigned 32-bit integer. The identifier of the lamp to be queried. 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.
lpdwLampMode (4 bytes): An unsigned 32-bit integer. Set to TAPI_NO_DATA (0xFFFFFFFF). Upon successful completion of the request, this field contains the lamp mode status of the specified lamp. The constant names, values, and descriptions are listed in 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.
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.