BACnetAlarmSummResponseCbCompletion (FUN)ΒΆ

FUNCTION BACnetAlarmSummResponseCbCompletion : IEC_BACNET_STATUS

Sends an AlarmSummary response.

Completes an Alarm Summary hook by generating an Alarm-Summary-ACK reply. Contains the information about all event-initiating objects that have an Event State property not equal to STATE_NORMAL and a Notify Type property equal to NOTIFY_TYPE_ALARM. This information is represented as a list of Alarm Summary data structures. The list may be NULL if no object was found; in this case the list length must be zero. This is a hook completion routine. All confirmed service hooks need to call a response or error completion routine to perform resoure cleanup and to send a response over the BACnet. The hook completion routine frees all resources it uses.

InOut:

Scope

Name

Type

Comment

Return

BACnetAlarmSummResponseCbCompletion

IEC_BACNET_STATUS

Input

phTransaction

POINTER TO BYTE

Transaction State Machine (TSM) handle for the request to be processed by the hook.

pSummaries

POINTER TO IEC_BACNET_ALARM_SUMMARY

A pointer to a memory block in which to place a list of Alarm Summary items. It may be NULL if the list contains no items. In this case, the nSummaryCount argument also has to be 0.

nSummaryCount

IEC_BACNET_UNSIGNED

The number of Alarm Summaries in the Alarm Summary list. If there are no items in the list, this argument is 0 and pSummaries is NULL too.