class NsLocalBackup

La classe NsLocalBackup décrit une sauvegarde locale dont les paramètres ont été transmis au serveur de sauvegarde.

Pour l'instant, les paramètres ne sont accessibles qu'en lecture via cette API.

ID : __int64

L'identificateur unique de la sauvegarde sur le serveur.

UserID : __int64

L'identificateur unique de l'utilisateur (NsUser) propriétaire de la sauvegarde.

LocalID : BSTR

L'identificateur unique de la sauvegarde sur le poste client.

CreationDate : VARIANT readonly

La date de création de la sauvegarde, au format UTC.

Name : BSTR

Le nom de la sauvegarde.

LastExecSucceeded : VARIANT_BOOL readonly

Indique si la dernière exécution a réussi, c'est à dire que la sauvegarde est arrivée à son terme sans reporter aucune erreur.

LastExecCompleted : VARIANT_BOOL readonly

Indique si la dernière exécution est arrivée à son terme.

LastExecCanceled : VARIANT_BOOL readonly

Indique si la dernière exécution a été annulée par l'utilisateur ou l'administrateur du serveur de sauvegarde.

LastExecDate : VARIANT readonly

La date de dernière sauvegarde, au format UTC.

IsLocked : VARIANT_BOOL readonly

Retourne un indicateur booléen indiquant si la sauvegarde est verrouillée ou non.

Revision : __int64 readonly

Le numéro de version des paramètres de la sauvegarde.

ProgressValue : long readonly

Un indicateur entre 0 et 100 indiquant la progression de la sauvegarde, si une opération est en cours.

StoredFiles : __int64 readonly

Le nombre de fichiers sauvegardés.

StoredBytes : __int64 readonly

Le nombre d'octets sauvegardés.

TargetDiskAvailability : enum NsLocalTargetDiskAvailabilityState readonly

L'indicateur de disponibilité du disque de sauvegarde par défaut défini sur le poste client.

VARIANT_BOOL LoadFromID(NsConnection Connection, __int64 BackupID)

Charge en mémoire la sauvegarde locale d'identificateur BackupID

VARIANT_BOOL GetComments(NsConnection Connection, BSTR Comments)

Retourne les commentaires associés à l'objet.

VARIANT_BOOL SetComments(NsConnection Connection, BSTR Comments)

Définit les commentaires associés à l'objet.

NsCustomAttributes CustomAttributes(NsConnection Connection)

Renvoit les attributs personnalisés de l'objet.

VARIANT_BOOL Lock(NsConnection Connection)

Verrouille la sauvegarde.

VARIANT_BOOL Unlock(NsConnection Connection)

Dévérouille la sauvegarde.

VARIANT_BOOL Delete(NsConnection Connection)

Supprime la sauvegarde loale représentée par l'objet.

NsBackupSchedulingStatus SchedulingStatus()

Retourne des informations sur la prochaine date d'exécution de la sauvegarde, calculée en fonction des paramètres de planification récurrents définis.

NsExecutionRequest CreateExecutionRequestForUser(NsConnection Connection, NsUser TargetUser, VARIANT_BOOL RetryIfInterrupted)

Poste une demande d'exécution de la sauvegarde représentée par l'objet par l'utilisateur TargetUser. Si RetryIfInterrupted vaut true, la sauvegarde est relancée par l'agent client tant que l'exécution n'arrive pas à son terme. La fonction retourne l'objet NsExecutionRequest correspondant, ou une référence d'objet invalide en cas d'erreur.

NsExecutionRequest CreateExecutionRequestForUserByID(NsConnection Connection, __int64 TargetUserID, VARIANT_BOOL RetryIfInterrupted)

Poste une demande d'exécution de la sauvegarde représentée par l'objet par l'utilisateur d'identificateur UserID. Si RetryIfInterrupted vaut true, la sauvegarde est relancée par l'agent client tant que l'exécution n'arrive pas à son terme. La fonction retourne l'objet NsExecutionRequest correspondant, ou une référence d'objet invalide en cas d'erreur.

NsServerAlertCollection Alerts(NsConnection Connection, VARIANT_BOOL OnlyRaised)

Renvoit les alertes associées à l'objet. Si OnlyRaised vaut true, seul les alertes déclenchées sont renvoyées.

NsHistoryCollection History(NsConnection Connection, long Limit)

Retourne les informations d'exécution sur les dernières opérations effectuées sur la sauvegarde. Si le paramètre Limit possède une valeur supérieure à 0, seul les Limit dernières opérations sont retournées.