ITPhone::get_ButtonMode method (tapi3if.h)

The get_ButtonMode method retrieves the button mode associated with a particular button.

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

Syntax

HRESULT get_ButtonMode(
  [in]  long              lButtonID,
  [out] PHONE_BUTTON_MODE *pButtonMode
);

Parameters

[in] lButtonID

Button identifier. For more information, see the following Remarks section.

[out] pButtonMode

The PHONE_BUTTON_MODE descriptor for the button's mode.

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_MODE enum and the TAPI 2.x documentation for more information about button modes.

The two following PHONE_BUTTON_MODE values are of particular interest:

1. If the PHONE_BUTTON_MODE value is PBM_FEATURE, the application should call the get_ButtonFunction to retrieve the specific meaning of the button.
2. If the PHONE_BUTTON_MODE value is PBM_KEYPAD, the button is a keypad button whose value is indicated by the value of the lButtonID parameter. For example, if lButtonID == 10 then the button is the * (star) key on the keypad.

Requirements

See also

ITPhone

get_ButtonFunction

put_ButtonMode