The SetReceivedUnsolicitedNotifyState API procedure can be called by application software to allow the media engine to receive and process unsolicited received NOTIFY messages. Unsolicited received NOTIFY messages are not associated with an event subscription. Unsolicited NOTIFY messages are sent to the media engine by far end SIP devices as determined by the far end SIP device. If you interface with another SIP device or server that will send your VOIP application NOTIFY SIP messages without you having to SUBSCRIBE to the NOTIFY events, then you will want to call this API procedure to enable unsolicited NOTIFY processing. For further information, see the SipEventNotifyReceived event.

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

Syntax

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

Parameters

EnableState
Type: System..::.Boolean
The enable state of unsolicited NOTIFY processing.

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