EVT_BACNET_CONFTEXTMESSAGE (STRUCT)

TYPE EVT_BACNET_CONFTEXTMESSAGE : STRUCT

The ConfirmedTextMessage service hook.

This is the type declaration for the Confirmed-Text-Message service application hook. This hook allows a BACnet application to process Confirmed-Text-Message service since there are no default processing of this service in the present API version. This hook is given all of the parameters of a service request, and is responsible for all error checking (Device/object/ Property existence, array index correctness, value correctness and any other service parameter given). A pointer to the routine is registered with the BACnet server by BACnetSetHook() API routine. A hook can be registered by the registering API routine at any time. One hook procedure is registered per service. If a hook is registered more than once for the same service, the new hook procedure replaces old one. A NULL procedure pointer can be used to deregister the hook. A Confirmed-Text-Message 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_TEXT_MESSAGE_INFO	A pointer to the service information data structure. This data structure of data type BACNET_TEXT_MESSAGE_INFO contains an object Identifier of Device object of the request initiator, a BACNET_BOOLEAN If-Message-Class-Present attribute, a message class, a message priority, a message string type and a message string.