BACnetUnregisterClientDataPoint (FUN)

FUNCTION BACnetUnregisterClientDataPoint : IEC_BACNET_STATUS

Releases an device object property reference from data acquisation.

The user application can remove device object property references from data acquisation which it doesn’t need anymore. If the user application has registered an callback for unsubscribe completion, it will get notified about the successful or unsuccessful unsubscription asynchronously.

Returns: BACNET_STATUS

BACNET_STATUS_BUSY: if unsubscription is pending. The registered unsubscribe-complete

callback will be called on completion to indicate that unregistration has been completed.

BACNET_STATUS_OK: unsubscription completed. The registered unsubscribe-complete

callback WILL NOT BE CALLED because other customers have an active registration on the same reference OR the data is retrieved by polling using read property or read property multiple.

OTHER: some other failure in given parameters has been detected

InOut:

Scope	Name	Type	Comment
Return	BACnetUnregisterClientDataPoint	IEC_BACNET_STATUS
Input	hCustomer	IEC_BACNET_HANDLE	An handle to an created advanced BACnet client customer created by BACnetOpenClientCustomer.
	devId	IEC_BACNET_INST_NUMBER	The device instance number from the remote or local device from which the value shall not be acquired anymore.
	pObjId	POINTER TO IEC_BACNET_OBJECT_ID	A pointer to the object identifier from the remote or local object from which the value shall not be acquired anymore.
	propId	IEC_BACNET_PROPERTY_ID	The property identifier from which the value shall not be acquired anymore.
	index	IEC_BACNET_ARRAY_INDEX	The property array index from which the value shall not be acquired anymore. If the property is not an array the value shall be BACNET_VOID_INDEX (-1) If the property is an array and the whole array should be acquired the value BACNET_ENTIRE_ARRAY (-1) shall be used here.
	bClockAlignedPolling	IEC_BACNET_BOOLEAN	If set to True the acquisation will be stopped for the clock aligned registered reference. If set to False the NON clock aligned reference will be removed.
	bForceUnsubscribe	IEC_BACNET_BOOLEAN	If set to True the unsubscription will be executed with nininmal delay instead of waiting for the next device alive check or waiting for new registrations.