phoneGetButtonInfoA function (tapi.h)

Article
02/22/2024

The phoneGetButtonInfo function returns information about the specified button.

Syntax

LONG phoneGetButtonInfoA(
  HPHONE            hPhone,
  DWORD             dwButtonLampID,
  LPPHONEBUTTONINFO lpButtonInfo
);

Parameters

hPhone

Handle to the open phone device.

dwButtonLampID

Button on the phone device.

lpButtonInfo

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 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_STRUCTURETOOSMALL, PHONEERR_OPERATIONUNAVAIL, PHONEERR_UNINITIALIZED.

Remarks

Note

The tapi.h header defines phoneGetButtonInfo as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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