The SetCallCancelTimeout procedure allows an application to control how long the media engine will wait for outgoing call CANCEL responses from the far end of the call.

When the media engine transmits a CANCEL request for an outgoing call, it expects to receive a "200 OK" response for the transmitted CANCEL request and a "487 Transaction Terminated" response for the initial INVITE request. Note that the "487 Transaction Terminated" response received will also be answered by a final ACK from the media engine.

The media engine will then wait the "CallCancelTimeout" as set by the API procedure for the "200 OK" response. It will also wait the "CallCancelTimeout" for the "487 Transaction Terminated" response. The order of these responses does not matter. If the media engine does not receive both expected responses, the phone call will proceed with cancel termination. If the responses arrive after the time out as set by the API procedure, the responses will be ignored.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallCancelTimeout(
	uint CallCancelTimeoutMs
)
Visual Basic (Declaration)
Public Function SetCallCancelTimeout ( _
	CallCancelTimeoutMs As UInteger _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallCancelTimeout(
	unsigned int CallCancelTimeoutMs
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallCancelTimeout(
	UInt32 CallCancelTimeoutMs
)

Parameters

CallCancelTimeoutMs
Type: System..::.UInt32
The number of milliseconds to wait for the expected call CANCEL responses as described above. Any value 2000 Ms or greater is acceptable.

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 VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
SipInvalidHandle
Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

Remarks

None.

See Also