Platform SDK: TAPI

phoneGetButtonInfo

The phoneGetButtonInfo function returns information about the specified button.

LONG WINAPI phoneGetButtonInfo(
  HPHONE hPhone,                  
  DWORD dwButtonLampID,           
  LPPHONEBUTTONINFO lpButtonInfo  
);

Parameters

hPhone
A handle to the open phone device.
dwButtonLampID
A button on the phone device.
lpButtonInfo
A pointer to a variably sized structure of type PHONEBUTTONINFO. This data structure describes the mode and the function, and provides additional descriptive text corresponding to the button.

Return Values

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_STRUCTURETOOSMALL, PHONEERR_OPERATIONUNAVAIL, 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.
  Unicode: Implemented as Unicode and ANSI versions on all platforms.

See Also

TAPI 2.2 Reference Overview, Supplementary Phone Service Functions, PHONEBUTTONINFO