Edit

TSPI_phoneSetLamp function (tspi.h)

  • Article

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

Syntax

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 value

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

Requirement Value
Target Platform Windows
Header tspi.h

See also

ASYNC_COMPLETION

PHONELAMPMODE_ Constants

TSPI_phoneGetDevCaps

TSPI_phoneGetLamp