phoneSetButtonInfo

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

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

Parameters

hPhone

A handle to the open phone device. The application must be the owner of the 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, the function, and provides additional descriptive text about the button.

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

QuickInfo

  Version: Use TAPI version 1.4 and later.
  Header: Declared in tapi.h.
  Import Library: Link with tapi32.lib.

See Also

TAPI Reference Overview, Supplementary Phone Services Functions, PHONE_REPLY, PHONEBUTTONINFO