EVT_BACNET_GETENROLLMENTSUMMARY (STRUCT)¶

TYPE EVT_BACNET_GETENROLLMENTSUMMARY : STRUCT

The GetEnrollmentSummary service hook. This is the type declaration for the Get Enrollment Summary service application hook. This hook allows a BACnet application to process Enrollment Summary service. This hook is given all of the parameters of a service request, and is responsible for all error checking (object/ Property existence, address correctness and any other service parameter given). A hook can be registered by the registering API routine at any time using BACnetSetHook(). One hook procedure is registered per service. If a hook is registered more than once for the same service, the new hook procedure replaces the old one. A NULL procedure pointer can be used to deregister the hook. A Get Enrollment Summary hook must complete its service request processing by using one of the transaction completion API routines: BACnetReadPropResponseCbCompletion, 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.

InOut:

Name	Type	Comment
pCBStatus	POINTER TO IEC_BACNET_CB_STATUS	CB-Status returned for the event. “Default” processes the standard APIs reaction, which needs no additional Callback-Signalling.
phTransaction	POINTER TO BYTE	This is the Transaction State Machine (TSM) handle for the current service request. It is generated by the BACnet API and is the first parameter given to the Hook- Completion functions.
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_ENROLLMENT_FILTER	A pointer to the Enrollment Filter data structure that indicates a set of filters which define the search criteria for the event-initiating objects to be summarized in the Get Enrollment Summary service.