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 TSPIAPI 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 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 PHONELAMPMODE_ constants.

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.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 1.3 or later.
  Header: Declared in Tspi.h.

See Also

ASYNC_COMPLETION, PHONELAMPMODE_ Constants, TSPI_phoneGetDevCaps, TSPI_phoneGetLamp