phoneSetButtonInfoA function (tapi.h)

Article
02/22/2024

The phoneSetButtonInfo function sets information about the specified button on the specified phone.

Syntax

LONG phoneSetButtonInfoA(
  HPHONE                  hPhone,
  DWORD                   dwButtonLampID,
  LPPHONEBUTTONINFO const lpButtonInfo
);

Parameters

hPhone

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

dwButtonLampID

Button on the phone device.

lpButtonInfo

Pointer to a variably sized structure of type PHONEBUTTONINFO. This data structure describes the mode, the function, and provides additional descriptive text about the button.

Return value

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_INVALBUTTONLAMPID, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPHONEHANDLE, PHONEERR_STRUCTURETOOSMALL, PHONEERR_INVALPOINTER, PHONEERR_UNINITIALIZED, PHONEERR_NOTOWNER, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL, PHONEERR_RESOURCEUNAVAIL.

Remarks

Note

The tapi.h header defines phoneSetButtonInfo 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