BACnetRegisterClientEventNotification (FUN)

FUNCTION BACnetRegisterClientEventNotification : IEC_BACNET_STATUS

Registers an device notification class reference for event and alarm acquisation.

This function enables the user appliaction to subscribe to an event and alarm source very easy. This function will do most of the work, normally a client application has to manage, just in one call. It checks periodical for the presence and online state for devices and checks for integrity of the alarms and event acquired from other devices.

InOut:

Scope	Name	Type	Comment
Return	BACnetRegisterClientEventNotification	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 events or alarms shall be acquired.
	notifClass	IEC_BACNET_INST_NUMBER	The notification class object instance number from the remote or local device from which the events or alarms shall be acquired.
	pValidTransitions	POINTER TO IEC_BACNET_BIT_STRING	A pointer to an bit string structure which contians the bits for the transitions on which a notification shall be sent. More information can be found under BACNET_DESTINATION
	pValidDays	POINTER TO IEC_BACNET_BIT_STRING	A pointer to an bit string structure which contians the bits for the weekdays on which a notification shall be sent. More information can be found under BACNET_DESTINATION
	pFromTime	POINTER TO IEC_BACNET_TIME	A pointer to a time structure which contains the start time at which notifications shall be sent. More information can be found under BACNET_DESTINATION
	pToTime	POINTER TO IEC_BACNET_TIME	A pointer to a time structure which contains the end time at which notifications shall NOT be sent anymore. More information can be found under BACNET_DESTINATION
	nSubscribeMode	IEC_BACNET_CLIENT_SUBSCRIBE_MODE	This defines how the data is acquired.
	pICallback	CmpEventMgr.ICmpEventCallback	A pointer to the event-callback interface which gets called on BACnet event notification. To unregister a NULL pointer shall be used here.
	pUserArg	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 pointer and the pUserFct pointer is associated with the given device instance and notification class object instance pair. So for every different combination of those parameters these pointers are stored. This pointer may be NULL.