ITLegacyCallMediaControl2::GenerateTone method (tapi3if.h)

The GenerateTone method generates the specified tone.

To generate custom tones, call the GenerateCustomTones (C/C++) or the GenerateCustomTonesByCollection method (Visual Basic and scripting applications).

Syntax

HRESULT GenerateTone(
  [in] TAPI_TONEMODE ToneMode,
  [in] long          lDuration
);

Parameters

[in] ToneMode

Indicates the tone mode. The values used are those from the TAPI_TONEMODE enumeration.

[in] lDuration

Both the duration, in milliseconds, of DTMF digits and pulse, and DTMF interdigit spacing.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_INVALIDARG
One of the parameters is invalid.
TAPI_E_INVALCALLSTATE
The call must be in the connected state.

Remarks

This method translates to a call to the TAPI 2.x lineGenerateTone function.

When tone generation finishes, an event of type TE_GENERATEEVENT is generated.

Requirements

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

See also

ITLegacyCallMediaControl2