ITAutomatedPhoneControl::get_PhoneHandlingEnabled method (tapi3if.h)

Article
02/22/2024

The get_PhoneHandlingEnabled method retrieves the current value of the PhoneHandlingEnabled property. Setting the property enables or disables all the automatic phone interaction features for this phone. Features include automated control of a phone's tones and rings, and automated call handling based on a phone's hookswitch state.

Syntax

HRESULT get_PhoneHandlingEnabled(
  [out] VARIANT_BOOL *pfEnabled
);

Parameters

[out] pfEnabled

VARIANT_TRUE if automated phone handling is enabled, VARIANT_FALSE if automated phone handling is not enabled. The default value is VARIANT_FALSE.

Return value

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

Remarks

Typically, an application sets other properties on the ITAutomatedPhoneControl interface (to configure the details of the automatic phone interaction features required) before setting the PhoneHandlingEnabled property to VARIANT_TRUE. However, you can also adjust the properties after you call the put_PhoneHandlingEnabled method to enable the features.

When the phone is closed with a call to the ITPhone::Close method, the PhoneHandlingEnabled property is automatically reset to VARIANT_FALSE.

For a list of property methods that get and set the automatic phone interaction features, see ITAutomatedPhoneControl.

Requirements

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