BACnetGetAlarmSummary (FUN)

FUNCTION BACnetGetAlarmSummary : IEC_BACNET_STATUS

Send an GetAlarmSummary request

This routine generates a Get Alarm Summary service request. It is used by a client BACnet user to obtain a summary of “alarm-active” objects within the given device that is capable of alarm processing. The “alarm-active” objects are objects that have any value but IEC_BACNET_EVENT_STATE.STATE_NORMAL for the Event_State property and IEC_BACNET_NOTIFY_TYPE.NOTIFY_TYPE_ALARM for the Notify_Type property.

InOut:

Scope	Name	Type	Comment
Return	BACnetGetAlarmSummary	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.
	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_ALARM_INFO	A pointer to a memory block of datatype IEC_BACNET_ALARM_INFO in which to place summary information, which is a list of Alarm Summary items. Each item of datatype IEC_BACNET_ALARM_SUMMARY consists of three parameters: Object ID of the appropriate object, the Event State of this object, and Acked Transitions property values. The application may initialize the pSummaries member of the IEC_BACNET_ALARM_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.