BACnetGetEnrollmentSummary (FUN)

FUNCTION BACnetGetEnrollmentSummary : IEC_BACNET_STATUS

Sends an GetEnrollmentSummary request

Obtains a summary of event-initiating objects within the given device. Several different filters may be applied to define the search criteria. This routine generates an GetEnrollmentSummary service request.

Asynchron call, which fills pResult with the call result in an asynchronus manner. As soon as pInfoBufferStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pResult is valid.

InOut:

Scope	Name	Type	Comment
Return	BACnetGetEnrollmentSummary	IEC_BACNET_STATUS	A status indicating if the operation worked.
Input	pSourceAddress	POINTER TO IEC_BACNET_ADDRESS	If the BACnet application has only one device constructed and installed, this can be 0. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction.
	pDestinationAddress	POINTER TO IEC_BACNET_ADDRESS	This is the MAC address of the device to which the request should be sent.
	pFilter	POINTER TO IEC_BACNET_ENROLLMENT_FILTER	This argument contains five filters: enrollment, event state, event type, priority, and notification class. Some of these filters are optional.
	pAPDUParams	POINTER TO IEC_BACNET_APDU_PROPERTIES	A pointer to the APDU-Properties structure which sets APDU properties for this transaction only. This does not change global defaults or settings for the application APDU Properties. This argument may be 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request.
	pInfoBuffer	POINTER TO IEC_BACNET_ENROLLMENT_INFO	A pointer to a memory block into which to place summary information, which is a list of Enrollment Summary items. Each item of datatype IEC_BACNET_ENROLLMENT_SUMMARY consists of the following parameters: the Object ID of the appropriate object, its event type, event state, notification priority, and notification class property values. The application may initialize the pSummaries member of the IEC_BACNET_ENROLLMENT_INFO struture with a 0 pointer and bufferCount and summaryCount with 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed.
	pTransactionToken	POINTER TO BACnetAsyncTransactionToken	Transaction token of the asynchronous call - see BACnetAsyncTransactionToken.
	pError	POINTER TO IEC_BACNET_ERROR	A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.