ITPhone::get_ButtonText method (tapi3if.h)

The get_ButtonText method retrieves the button text associated with a particular button.

The application must call ITPhone::Open before invoking this method; otherwise, the invocation fails. See the TAPI 2.x documentation for more information about the concept of button text.

Syntax

HRESULT get_ButtonText(
  [in]  long lButtonID,
  [out] BSTR *ppButtonText
);

Parameters

[in] lButtonID

Button identifier.

[out] ppButtonText

The BSTR representation of the button text. The BSTR is allocated using SysAllocString. The BSTR argument should be deallocated by the client.

Return value

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

Requirements

See also

ITPhone

put_ButtonText