BACnetRegisterClientUnsubscribeCompletionCallback
(FUN)
FUNCTION BACnetRegisterClientUnsubscribeCompletionCallback : IEC_BACNET_STATUS
Registers the user application callback for completed unregistrations.
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.
Return: IEC_BACNET_STATUS
- InOut:
Scope
Name
Type
Comment
Return
BACnetRegisterClientUnsubscribeCompletionCallback
Input
hCustomer
An handle to an created advanced BACnet client customer created by ::BACnetOpenClientCustomer.
pICallback
CmpEventMgr.ICmpEventCallback
Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_CLIENT_UNSUBSCRIBE_COMPLETE. Purpose documented in BACstack: A pointer to the user application function which gets called on completion of an unregistration.
pUserUnsubArg
POINTER TO IEC_BACNET_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.