EnableIncomingPhoneRing can be called by application software to enable or disable the ability of the telephony engine to create an incoming phone ring tone when receiving an inbound call.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE EnableIncomingPhoneRing(
	bool EnableState
)
Visual Basic (Declaration)
Public Function EnableIncomingPhoneRing ( _
	EnableState As Boolean _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE EnableIncomingPhoneRing(
	bool EnableState
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE EnableIncomingPhoneRing(
	boolean EnableState
)

Parameters

EnableState
Type: System..::.Boolean
The enable state of incoming phone call ring generation. The state of incoming ring generation 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 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)

Remarks

None.

See Also