BACnetStack_SetBackupAndRestoreEnabled

bool BACnetStack_SetBackupAndRestoreEnabled(
  const uint32_t deviceInstance,
  const uint16_t backupPreparationTime,
  const uint16_t restorePreparationTime,
  const uint16_t restoreCompletionTime,
  const uint16_t backupFailureTimeout,
  const bool enabled);

Enables or disables the Backup and Restore functionality on a device.

Note

This call and BACnetStack_AddFileObject(…, isConfigurationFile = true) may be made in EITHER ORDER. Enabling configures the feature; it does not discard configuration files that have already been declared.

Note

Requires the STACK_OPTION_DM_BR_BACKUP_AND_RESTORE build option.

BACnet reference: ANSI/ASHRAE 135-2024 clause 19.1 (Backup and Restore).

Parameters

Parameter	Direction	Description
deviceInstance	in	The instance of the device to enable or disable the Backup and Restore services on.
backupPreparationTime	in	How many seconds the device may stay silent once a backup procedure starts.
restorePreparationTime	in	How many seconds the device may stay silent once a restore procedure starts.
restoreCompletionTime	in	How many seconds the device may stay silent as a restore procedure finishes.
backupFailureTimeout	in	The initial Backup_Failure_Timeout in seconds: how long the device waits before unilaterally ending a backup or restore procedure (135-2024 cl. 12.11.38, Unsigned16). The property stays writable over the wire afterwards; this is the power-on value. PASS A NON-ZERO VALUE. A zero timeout expires the failure timer on the next tick after STARTBACKUP, so the backup silently resets itself and never completes.
enabled	in	True to enable the Backup and Restore properties, false to disable them. Disabling also empties the configuration-file list, since Configuration_Files itself is turned off. Disabling while a backup or restore procedure is running ends it as the Backup_Failure_Timeout would: CallbackCompleteBackup, or CallbackCompleteRestore with wasAborted true, is called from inside this call, and System_Status leaves backup-in-progress or download-in-progress. The procedure has already ended when the callback runs, so calling this function again from that callback does nothing more.

Returns

True if successful, false if failed.

Topic: Device and services. Declared in CASBACnetStackDLL.h.