| Syntax | LONG TSPI_phoneSetLamp(dwRequestID, hdPhone, dwButtonLampID, dwLampMode) This function causes the specified lamp to be lit on the specified open phone device in the specified lamp mode. |
| Parameters | DRV_REQUESTID dwRequestID Specifies the identifier of the asynchronous request. The Service Provider returns this value if the function completes asynchronously. |
| HDRVPHONE hdPhone Specifies the Service Provider's opaque handle to the phone phone whose lamp is to be lit. | |
| DWORD dwButtonLampID Identifies the button whose lamp is to be lit. | |
| DWORD dwLampMode Specifies how the lamp is to be lit, of type PHONELAMPMODE. Values are: | |
| PHONELAMPMODE_BROKENFLUTTER Broken flutter is the superposition of flash and flutter. | |
| PHONELAMPMODE_FLASH Flash means slow on and off. | |
| PHONELAMPMODE_FLUTTER Flutter means fast on and off. | |
| PHONELAMPMODE_OFF The lamp is off. | |
| PHONELAMPMODE_STEADY The lamp is continuously lit. | |
| PHONELAMPMODE_WINK The lamp is winking. | |
| Return Value | Returns zero if the function is successful, the (positive) dwRequestID value if the function will be completed asynchronously, or a negative error number if an error has occurred. Possible error returns are: |
| PHONEERR_INVALPHONEHANDLE The specified device handle is invalid. | |
| PHONEERR_INVALBUTTONLAMPID The specified button/lampID is out of range. | |
| PHONEERR_INVALPHONESTATE The phone device is not in a valid state for the requested operation. | |
| PHONEERR_INVALLAMPMODE The specified lamp mode parameter is invalid. | |
| PHONEERR_OPERATIONUNAVAIL The specified operation is not available. | |
| PHONEERR_OPERATIONFAILED The specified operation failed for unspecified reason. | |
| Comments | None. |
| See Also | Functions: TSPI_phoneGetDevCaps, TSPI_phoneGetLamp Data Types: PHONELAMPMODE |