Edit

ITPhone::put_HookSwitchState method (tapi3if.h)

  • Article

The put_HookSwitchState method sets the current hookswitch state for a particular hookswitch device on the phone.

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

Syntax

HRESULT put_HookSwitchState(
  [in] PHONE_HOOK_SWITCH_DEVICE HookSwitchDevice,
  [in] PHONE_HOOK_SWITCH_STATE  HookSwitchState
);

Parameters

[in] HookSwitchDevice

The PHONE_HOOK_SWITCH_DEVICE descriptor for the hookswitch type.

[in] HookSwitchState

The PHONE_HOOK_SWITCH_STATE descriptor for the hookswitch status.

Return value

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

Remarks

Typically, speakerphones and headsets have application-settable hookswitch states, and handsets do not, but this feature is TSP-dependent.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITPhone

get_HookSwitchState