ITAutomatedPhoneControl::get_AutoDialtone method (tapi3if.h)

Article
10/13/2021

The get_AutoDialtone method retrieves the current value of the AutoDialtone property. When this feature is enabled, the phone going offhook results in a dial tone produced on the audio render device associated with the phone. No dial tone is produced if the phone was ringing when it went offhook.

Syntax

HRESULT get_AutoDialtone(
  [out] VARIANT_BOOL *pfEnabled
);

Parameters

[out] pfEnabled

If VARIANT_TRUE, auto dial tone is enabled. If VARIANT_FALSE, auto dial tone is disabled.

Return value

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

Remarks

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

All dial tone generation ceases when an invocation of ITAutomatedPhoneControl::SelectCall succeeds; dial tone generation remains suspended until the call is unselected.

Requirements

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