ITAutomatedPhoneControl::get_AutoStopTonesOnOnHook method (tapi3if.h)

Article
10/13/2021

The get_AutoStopTonesOnOnHook method retrieves the current value of the AutoStopTonesOnOnHook property. When this feature is enabled, the phone going onhook results in the termination of any tone produced on the audio render device associated with the phone (via a call to ITAutomatedPhoneControl::StopTone).

Syntax

HRESULT get_AutoStopTonesOnOnHook(
  [out] VARIANT_BOOL *pfEnabled
);

Parameters

[out] pfEnabled

If VARIANT_TRUE, automatic stop of tone generation upon onhook is enabled. If VARIANT_FALSE, automatic stop of tone generation upon onhook is disabled.

Return value

If the method succeeds, it returns S_OK. Otherwise, it returns an error value.

Remarks

The AutoStopTonesOnOnHook property functions only when the value of the PhoneHandlingEnabled property is VARIANT_TRUE. You can set the AutoStopTonesOnOnHook property at any time. The reconfiguration takes effect the next time the phone goes onhook.

Requirements

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