Edit

Share via

ITLegacyCallMediaControl2::GenerateDigits2 method (tapi3if.h)

  • Article

The GenerateDigits2 method causes digits to be output on the current call. This method extends the ITLegacyCallMediaControl::GenerateDigits method by adding a duration parameter.

Syntax

HRESULT GenerateDigits2(
  [in] BSTR           pDigits,
  [in] TAPI_DIGITMODE DigitMode,
  [in] long           lDuration
);

Parameters

[in] pDigits

A pointer to a BSTR representation of the digits to generate.

[in] DigitMode

Indicates the digit mode. Valid values are those from the TAPI 2.x LINEDIGITMODE_constants.

[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_POINTER
 The pDigits parameter is not a valid pointer.
TAPI_E_INVALCALLSTATE
 The call must be in the connected state.

Remarks

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

When digit 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