ITAutomatedPhoneControl::put_AutoKeypadTones method (tapi3if.h)

Article
02/22/2024

The put_AutoKeypadTones method sets the AutoKeypadTones property for this phone. When this feature is enabled, a digit tone is automatically played whenever a keypad button is pressed.

Syntax

HRESULT put_AutoKeypadTones(
  [in] VARIANT_BOOL fEnabled
);

Parameters

[in] fEnabled

If VARIANT_TRUE, automatic phone keypad tone generation is enabled. If VARIANT_FALSE, keypad tone generation is disabled. The default value is VARIANT_TRUE.

Return value

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

Remarks

If the phone device reports a button press as PBS_DOWN, then the tone is played until the phone device reports a PBS_UP event or until the minimum duration has expired, whichever is longer. (The minimum duration is determined by the AutoKeypadTonesMinimumDuration property.)

Keypad tone generation will occur only when the phone is offhook. If another tone, such as ringback, is currently playing, the keypad tone will interrupt that tone and automatically restore it after the keypad tone has finished.

The AutoKeypadTones property functions only when the value of the PhoneHandlingEnabled property is VARIANT_TRUE. You can set the AutoKeypadTones property at any time. The reconfiguration takes effect the next time the phone keypad button is pressed.

Requirements

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