phoneSetLamp

The phoneSetLamp function causes the specified lamp to be lit on the specified open phone device in the specified lamp mode.

LONG WINAPI phoneSetLamp(
  HPHONE hPhone,         
  DWORD dwButtonLampID,  
  DWORD dwLampMode       
);

Parameters

hPhone

A handle to the open phone device. The application must be the owner of the phone.

dwButtonLampID

The button whose lamp is to be lit.

dwLampMode

How the lamp is to be lit. This parameter uses one and only one of the PHONELAMPMODE_ Constants.

Return Values

Returns a positive request identifier if the function is completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding PHONE_REPLY message is zero if the function succeeds or it is a negative error number if an error occurs. Possible return values are:

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

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 Tapi.h.
  Library: Use Tapi32.lib.

See Also

TAPI 2.2 Reference Overview, Supplementary Phone Service Functions, PHONE_REPLY