EVT_BACNET_OBJECT_DATA_PROGRESS (STRUCT)¶

TYPE EVT_BACNET_OBJECT_DATA_PROGRESS : STRUCT

Prototype definition for the callback function which provides the object information to the application for the requested object.

This callback is called on a successful scan completion or on any error condition for every object in the device. The device-object will always be the first object here. Other objects will in random order because of multiple concurrent actions if not restricted to 1.

::BAC_BOOLEAN If the user callback returns FALSE here the current scan procedure is cancelled and no further callbacks will be issued.

InOut:

Name	Type	Comment
`pCBReturn`	POINTER TO IEC_BACNET_BOOLEAN	Return for the event. ::BAC_BOOLEAN If the user callback returns FALSE here the current scan procedure is cancelled and no further callbacks will be issued.
`phTransaction`	POINTER TO BYTE	The handle which identifies the transaction handled by the user application. The given handle has to be unique, in case the application needs to separate multiple pending requests. This handle is transparent for the BACnet API and is returned unchanged to the user application in the completion function callback. This handle may be NULL, but the user application will be unable to cancel pending requests by a call to ::BACnetCancelPendingConfirmedRequest or to separate them in the callback if multiple completions are pending in such case.
`status`	IEC_BACNET_STATUS	Contains the current status of operation. A value != ::BACNET_STATUS_OK represents an error condition. Additional information may be available in pError.
`pError`	POINTER TO IEC_BACNET_ERROR	Contains the most recent BACnet error occurred during the process. Only valid if status has not the value BACNET_STATUS_OK.
`pInfo`	POINTER TO IEC_BACNET_OBJECT_DATA_INFO	Pointer to structure containing all requested object information.
`nObjectsFound`	IEC_BACNET_UINT	Number of objects found during device scan.
`nObjectssProcessed`	IEC_BACNET_UINT	Number of objects which have been processed.
`bProcedureFinished`	IEC_BACNET_BOOLEAN	This parameter is TRUE if the retrieve procedure has been completed successfully or not and the request is complete. If the user application cancelles the processing no completion callback will be issued.