ITAutomatedPhoneControl::put_AutoStopTonesOnOnHook method (tapi3if.h)

Article
02/22/2024

The put_AutoStopTonesOnOnHook method sets the AutoStopTonesOnOnHook property for this phone. 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 put_AutoStopTonesOnOnHook(
  [in] VARIANT_BOOL fEnabled
);

Parameters

[in] fEnabled

If VARIANT_TRUE, enables automatic stop of tone generation if the phone goes onhook. If VARIANT_FALSE, disables automatic stop if the phone goes onhook. The default value is VARIANT_TRUE.

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