When an application receives the SipSubscriptionReceived event, it has the opportunity to accept
or decline an event subscription from another application or device. If the application indicates
that the subscription request can not be granted, then the application has no need to ever call
this API procedure.
If however the application decides to grant the event subscription, then the application takes ownership
of the notification handle that is specified during the SipSubscriptionReceived event processing. If
the application takes ownership of a notification handle, it should call this API procedure before it
fully terminates for each notification handle it owns. It should also call this API procedure when the
requesting application or device indicates that it no longer wants to subscribe to the specific
subscription event.
Namespace:
LanScapeAssembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
| C# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE CloseNotifyHandle() |
| Visual Basic (Declaration) |
|---|
Public Function CloseNotifyHandle As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
| Visual C++ |
|---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE CloseNotifyHandle() |
| J# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE CloseNotifyHandle() |
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 Value | Description |
|---|---|
| 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
