TSPI_phoneSetLamp

The TSPI_phoneSetLamp function causes the specified lamp to be set on the specified open phone device in the specified lamp mode.

LONG TSPI_phoneSetLamp(
  DRV_REQUESTID dwRequestID,  
  HDRVPHONE hdPhone,          
  DWORD dwButtonLampID,       
  DWORD dwLampMode            
);
 

Parameters

dwRequestID

The identifier of the asynchronous request.

hdPhone

The handle to the phone phone whose lamp is to be set.

dwButtonLampID

The button whose lamp is to be set.

dwLampMode

Specifies how the lamp is to be lit. The dwLampMode parameter can only have one of the following PHONELAMPMODE_ bits set:

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 Values

Returns dwRequestID, or an error number if an error occurs. The lResult actual parameter of the corresponding ASYNC_COMPLETION is zero if the function succeeds or it is an error number if an error occurs. Possible return values are as follows:

PHONEERR_INVALPHONEHANDLE, PHONEERR_NOMEM, PHONEERR_INVALBUTTONLAMPID, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALLAMPMODE, PHONEERR_OPERATIONUNAVAIL.

See Also

ASYNC_COMPLETION, PHONELAMPMODE_ Constants, TSPI_phoneGetDevCaps, TSPI_phoneGetLamp