EnableOutgoingDtmfDigits

 

EnableOutgoingDtmfDigits can be called by application software to enable or disable the ability of the telephony engine to present dialed DTMF tones to the user when an out going phone call is placed. If DTMF tones are enabled, the tones a user hears represent the IP address of the call destination.

 

 

TELEPHONY_RETURN_VALUE EnableOutgoingDtmfDigits(

SIPHANDLE hStateMachine,

BOOL EnableState

);

 

 

 

Parameters:

 

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

 

EnableState

[in] The enable state of DTMF tone generation. The state of DTMF tone generation enable affects all phone lines of the telephony engine.

 

 

Return Value:

 

If the function succeeds, the return value will be SipSuccess.

 

If the function fails, the return value will be one of the following values as specified by the TELEPHONY_RETURN_VALUE data type.

 

 

 

Value

Description

SipCallFailure

This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.

 

SipInvalidHandle

An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.