EVT_BACNET_BACKUPRESTORE_PROGRESS (STRUCT)ΒΆ
TYPE EVT_BACNET_BACKUPRESTORE_PROGRESS : STRUCT
Called to inform user application about the progress made to backup or restore an BACnet device.
This function will be called as an progress indicator and failure reporter during an BACnet backup or restore procedure.
::BAC_BOOLEAN If the user callback returns FALSE here the current backup / restore procedure is cancelled.
- 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 backup / restore procedure is cancelled.
phTransaction
POINTER TO BYTE
A pointer for user application purposes. This pointer is the same pointer which was given by call to ::BACnetBackupBACnetDevice or ::BACnetRestoreBACnetDevice.
deviceInstance
The device instance number which is currently processed.
pFileObjectName
POINTER TO IEC_BACNET_STRING
The object name from the file object which is currently processed.
pFileObjectDescription
POINTER TO IEC_BACNET_STRING
The optional object description from the file object which is currently processed. This may be NULL if no description is available.
fileInstance
The instance number from the file object which is currently processed.
totalFileCount
The number of total files to be processed.
actualFileNumber
The actual file number which is processed.
totalFileSize
The total size to restore or to be backed up. 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
The actual size restored or backed up. 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
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.
bProcedureFinished
This parameter is TRUE if the procedure has been completed successfully or not.