BACnetRegisterClientUnsubscribeCompletionCallback (FUN)

FUNCTION BACnetRegisterClientUnsubscribeCompletionCallback : IEC_BACNET_STATUS

Registers the user application callback for completed unregistrations.

This registers a callback routine. This callback can be registered at any time. If the callback is registered more than once, the new callback procedure replaces old one. A NULL pointer cancels the callback. This function gives a user application the ability to get notified if an unregistration of device object property reference has completed. Depending on the type of registration made (COV, COVP or POLLING), an unregistration may need some time to be processed. The function for initiation of the unregistration BACnetUnregisterClientDataPoint completes directly but the callback is called after the unsubscription for event or value notification in the remote device has completed. The application may only expect unsubscribe complete callbacks for which the BACnetUnregisterClientDataPoint function call has returned the BACNET_STATUS_BUSY. In case that all registered references have been retrievd by polling this function callback will also be called for the last customer which unregisters the last reference to an device but the referenced object will be the device and the property will be PROP_ALL and the index BACNET_VOID_INDEX (-1).

InOut:

Scope

Name

Type

Comment

Return

BACnetRegisterClientUnsubscribeCompletionCallback

IEC_BACNET_STATUS

Input

hCustomer

IEC_BACNET_HANDLE

An handle to an created advanced BACnet client customer created by BACnetOpenClientCustomer.

pICallback

CmpEventMgr.ICmpEventCallback

A pointer to the event-callback interface which gets called which gets called on completion of an unregistration. To unregister a NULL pointer shall be used here.

pUserUnsubArg

POINTER TO BYTE

A pointer to data from the user application which is transparent for the API. This pointer will not be modified by the BACnet API. This may be NULL.