phoneGetLamp function (tapi.h)

Article
02/22/2024

The phoneGetLamp function returns the current lamp mode of the specified lamp.

Syntax

LONG phoneGetLamp(
  HPHONE  hPhone,
  DWORD   dwButtonLampID,
  LPDWORD lpdwLampMode
);

Parameters

hPhone

Handle to the open phone device.

dwButtonLampID

Identifier of the lamp to be queried.

lpdwLampMode

Pointer to a memory location that holds the lamp mode status of the given lamp. This parameter uses one and only one of the PHONELAMPMODE_ Constants.

Return value

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

PHONEERR_INVALPHONEHANDLE, PHONEERR_NOMEM, PHONEERR_INVALBUTTONLAMPID, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPOINTER, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPHONESTATE, PHONEERR_UNINITIALIZED, PHONEERR_OPERATIONUNAVAIL.

Remarks

Phone sets that have multiple lamps per button should be modeled using multiple button/lamp pairs. Each extra button/lamp pair should use a DUMMY button.

Requirements

Requirement	Value
Target Platform	Windows
Header	tapi.h
Library	Tapi32.lib
DLL	Tapi32.dll