EVT_BACNET_ALARM_SUMM (STRUCT)¶

TYPE EVT_BACNET_ALARM_SUMM : STRUCT

The GetAlarmSummary service hook.

A Get Alarm Summary hook must complete its service request processing by using one of the transaction completion API routines: ::BACnetAlarmSummResponseCbCompletion, ::BACnetSrvcAbortCbCompletion, ::BACnetSrvcErrorCbCompletion, ::BACnetSrvcIgnoreCbCompletion, or ::BACnetSrvcRejectCbCompletion. Hooks can access the local Properties maintained in the API database by using the ::BACnetStorePropertyInstance / ::BACnetRetrievePropertyInstance routines. A hook can choose not to override the default API processing of a service request by returning the value ::CB_STATUS_DEFAULT.

Return: IEC_BACNET_CB_STATUS

InOut:

Name	Type	Comment
pCBStatus	POINTER TO IEC_BACNET_CB_STATUS	CB-Status returned for the event. CB_STATUS_DEFAULT: The hook did not handle the requests - the BACnet API stack default actions should handle the request. CB_STATUS_OK: The hook completed successfully.
phTransaction	POINTER TO BYTE	This handle identifies the current request in the API’s internal transaction state machine.
sourceAddress	POINTER TO IEC_BACNET_ADDRESS	This is the MAC address of the BACnet addressed device from which the request has been sent.
destinationAddress	POINTER TO IEC_BACNET_ADDRESS	This is the MAC address of the device constructed by the application which has received the request.
pServiceInfo	POINTER TO IEC_BACNET_BYTE	Because this service request doesn’t have any service parameters in the current protocol revision this pointer is NULL.