ITPhone::get_ButtonFunction method (tapi3if.h)

The get_ButtonFunction method retrieves the button function associated with a particular button.

The application must call the ITPhone::Open method before invoking this method; otherwise, the method fails.

Syntax

HRESULT get_ButtonFunction(
  [in]  long                  lButtonID,
  [out] PHONE_BUTTON_FUNCTION *pButtonFunction
);

Parameters

[in] lButtonID

Button identifier.

[out] pButtonFunction

The PHONE_BUTTON_FUNCTION descriptor for the button's function.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

See the description of the PHONE_BUTTON_FUNCTION enum for a list of possible button functions.

Requirements

See also

ITPhone

put_ButtonFunction