EVT_BACNET_FILEACCESS_PROGRESS (STRUCT)¶

TYPE EVT_BACNET_FILEACCESS_PROGRESS : STRUCT

Prototype definition for the callback function which provides the file access progress information to the application.

This callback is called on progress changes for the file access service.

::BAC_BOOLEAN If the user callback returns FALSE here the current transfer 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 transfer 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.
`totalFileSize`	IEC_BACNET_UNSIGNED	The total size to read or write. In case of an stream accessed file this is the number of octets. In case of an record accessed file this is the number of records.
`actualFileSize`	IEC_BACNET_UNSIGNED	The actual size already read or written. In case of an stream accessed file this is the number of octets. In case of an record accessed file this is the number of records.
`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 if the error is related to communication problems.
`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.
`bProcedureFinished`	IEC_BACNET_BOOLEAN	This parameter is TRUE if the transfer 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.