class NsBackupOperation

Aperçu

La classe NsBackupOperation permet d'exécuter une opération transactionelle sur le serveur de sauvegarde.

Propriétés

UserProfileID : BSTR

L'identificateur du profil utilisateur associé à la sauvegarde à exploiter.

BackupID : __int64

L'identificateur numérique de la sauvegarde à exploiter. Si vous ne connaissez pas cet identificateur, vous pouvez utiliser AssignBackupByName pour tenter de convertir un nom de sauvegarde en identificateur numérique valide.

Async : VARIANT_BOOL

Une variable booléenne indiquant si l'appel à Backup, Clear, Remove ou Restore doit rendre immédiatement la main ou non. Par défaut, les opérations sont asynchrones, c'est à dire que la main est immédiatement rendue après l'appel.

Méthodes

VARIANT_BOOL AssignBackupByName(BSTR BackupName)

Obtient l'identifiant unique d'une sauvegarde à partir de son nom BackupName. La sauvegarde est recherchée parmi les sauvegardes appartenant à l'utilisateur dont l'identificateur de profil est assigné à la variable membre UserProfileID. Une variable booléenne est retournée pour indiquer si le nom de la sauvegarde a pu être résolu avec succès ou non.

VARIANT_BOOL Backup()

Exécute la sauvegarde dont l'identificateur est assigné à BackupID, et retourne si l'opération a pu démarrer correctement ou non.

VARIANT_BOOL Clear()

Réinitialise la sauvegarde dont l'identificateur est assigné à BackupID, et retourne si l'opération a pu être initiée correctement ou non.

VARIANT_BOOL Remove()

Supprime la sauvegarde dont l'identificateur est assigné à BackupID, et retourne si l'opération a pu être initiée correctement ou non.

VARIANT_BOOL Restore()

Lance l'assistant de restauration pour la sauvegarde dont l'identificateur est assigné à BackupID, et retourne si l'opération a pu a pu être initiée correctement ou non.

VARIANT_BOOL ExecuteLogonBackups()

Exécute les sauvegardes d'ouverture de session.

VARIANT_BOOL ExecuteLogoffBackups()

Exécute les sauvegardes de fermeture de session.

VARIANT_BOOL ExecuteTaskFromFile(BSTR FilePath)

Exécute une sauvegarde à partir d'un fichier de commandes placé à l'adresse FilePath.

VARIANT_BOOL ExecuteTasksGroupFromFile(BSTR FilePath)

Exécute un groupe de sauvegardes à partir d'un fichier de commandes placé à l'adresse FilePath.

Exemples

Exécution d'une sauvegarde à partir de son nom

set backupOperation = CreateObject("NsClientAPI.NsBackupOperation")
set cnxMngr = CreateObject("NsClientAPI.NsConnectionManager")

' On suppose qu'un seul profil utilisateur est paramétré sur le poste
backupOperation.UserProfileID = cnxMngr.DefaultUser.LocalID
' On veut que l'appel à Backup() rende la main uniquement lorsque l'opération est terminée
backupOperation.Async = false
' On définit la sauvegarde à exécuter à partir de son nom.
if backupOperation.AssignBackupByName(InputBox("Saisissez le nom d'une sauvegarde a exécuter ", "Test de l'API UB", "")) then
  ' Si on est ici, la sauvegarde peut être exécutée correctement.
  MsgBox "La sauvegarde va être démarrée."
  ' On démarre la sauvegarde.
  if backupOperation.Backup then
    MsgBox "La sauvegarde a été exécutée."
  else
    MsgBox "Erreur lors du lancement de la sauvegarde."
  end if
else
  MsgBox "La sauvegarde dont vous avez saisi le nom ne peut être localisée !"
end if