Methods and Properties of BackupSet Interface

• Name - property, name of backup set.

  Syntax:

  Object.Name

  {property [in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MsgBox MySet.Name 'show the name of backup set
  MySet.Name = "NewBackupSetName" 'rename the set into "NewBackupSetName"
• Run - to run the backup process.

  Syntax:

  Object.Run

  {method}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Run 'run backup
• Stop - to stop backup process.

  Syntax:

  Object.Stop

  {method}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Stop 'stop backup
• Incremental - property, type of backup: incremental (true) or not (false).

  Syntax:

  Object.Incremental

  {property[in, out] BOOL}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Incremental = true 'set incremental backup
• Compression - property, type of compression.

  Syntax:

  Object.Compression

  {property[in, out] BSTR}

  Recieves and returns the following values:
  1. "None"
  2. "Zip-File"
  3. "Zip-Folder"
  4. "Zip-Single"
  
  

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Compression = "Zip-File" 'zip every file
• EncryptionEnable - property, encryption: on (true) or off (false).

  Syntax:

  Object.EncryptionEnable

  {property[in, out] BOOL}

• EncryptionPassword - property, password for encryption.

  Syntax:

  Object.EncryptionPassword

  {property[in] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.EncryptionEnable = true 'encryption is on
  MySet.EncryptionPassword = "Password" 'password
• RefreshOnlyLocalFiles - property, refresh the local files only: yes (true), no (false).

  Syntax:

  Object.RefreshOnlyLocalFiles

  {property[in, out] BOOL}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.RefreshOnlyLocalFiles = false 'refresh local and remote files
• ApplyChanges - to apply the changes to a backup set.

  We’ve included the “Delayed changes” option in the COM interface. It means that the specified properties and methods might be applied later, not immediately.

  The model of “Delayed changes” is necessary to raise the work speed of COM interface. Any changes in the settings might change the backup copy itself. To make the copy relevant you have to refresh the backup set, which takes some additional time. Therefore it can reduce the COM interface work.

  However you can also apply the changes immediately by using the simultaneous model of ‘ApplyChanges’ command.

  When you finish backup set setup you should call ‘ApplyChanges’ before:

  • Run backup - by using ‘Run’ method;
  • Restore data - by using ‘RestoreAllTo’ method;
  • “Backup Set” object is destroyed - by leaving out of scope, script completion or assigning to the ‘BackupSet’ variable other value.

  to changes take effect.

  Syntax:

  Object.ApplyChanges

  {method}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.ApplyChanges 'apply the changes immediately
• RestoreAllTo - to restore all files from set to specified folder.

  Syntax:

  Object.RestoreAllTo

  {method}

  Parameters:

  strFolderPath

  Path of folder where you want to restore the files

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.RestoreAllTo("c:\RestorePath\") 'restore all files to "c:\RestorePath\"