The SetCallHoldType function allows you to specify the type of call hold logic that will be used by the Media Engine.

There are two basic types of call hold logic that are acceptable. One type is defined by RFC2543 (c=0.0.0.0) and the newer call hold type as defined by RFC3261 (sendonly/recvonly).

By default, the Media Engine uses both types at the same time. If however there is a situation that dictates that you use a specific call hold type, call this API procedure to achieve the results you require.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallHoldType(
	VoipMediaEngine..::.CALL_HOLD_TYPE CallHoldType
)
Visual Basic (Declaration)
Public Function SetCallHoldType ( _
	CallHoldType As VoipMediaEngine..::.CALL_HOLD_TYPE _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallHoldType(
	VoipMediaEngine..::.CALL_HOLD_TYPE CallHoldType
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallHoldType(
	VoipMediaEngine..::.CALL_HOLD_TYPE CallHoldType
)

Parameters

CallHoldType
Type: LanScape..::.VoipMediaEngine..::.CALL_HOLD_TYPE
The call hold type to enable. For further information, see the VoipMediaEngine..::.CALL_HOLD_TYPE enumeration.

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
SipCallFailure
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

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)

SipBadParameter
One of the telephony API procedures was called by application software and was passed a pointer to an invalid memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API. For managed code applications, you should never see this error unless your process space has exhausted memory.

(API return value)

Remarks

None.

See Also