CloseNotifyHandle

 

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.

 

TELEPHONY_RETURN_VALUE CloseNotifyHandle(

SIPHANDLE hStateMachine,

NOTIFY_HANDLE NotifyHandle

);

 

 

 

Parameters:

 

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

 

NotifyHandle

[in] A notification handle that was specified in the SUBSCRIBE_REQUEST structure that was passed to the application when the application processed the SipSubscriptionReceived event.

 

 

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

 

 

 

Value

Description

SipCallFailure

This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.

 

SipInvalidHandle

An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.