Méthode CVssWriter::OnBackupShutdown (vswriter.h)

La méthode OnBackupShutdown est appelée par un rédacteur à la suite d’un événement BackupShutdown . Il est utilisé pour effectuer des opérations jugées nécessaires lorsqu’une application de sauvegarde s’arrête, en particulier en cas de plantage de l’application de sauvegarde.

OnBackupShutdown est une méthode virtuelle. Il est implémenté par la classe de base CVssWriter , mais peut être remplacé par des classes dérivées.

Syntaxe

bool OnBackupShutdown(
  [in] VSS_ID SnapshotSetId
);

Paramètres

[in] SnapshotSetId

Identificateur du jeu de cliché instantané impliqué dans l’opération de sauvegarde.

Valeur retournée

Comme implémenté par la classe de base, OnBackupShutdown retourne toujours true

Toute autre implémentation de cette méthode doit retourner true , sauf en cas d’erreur irrécupérable. Si une erreur irrécupérable se produit, la méthode doit appeler la méthode CVssWriter::SetWriterFailure pour fournir une description de l’échec avant de retourner false. Si une erreur non fatale se produit, la méthode doit toujours appeler SetWriterFailure , mais retourner true. Si l’erreur est provoquée par un problème temporaire, la méthode doit spécifier VSS_E_WRITERERROR_RETRYABLE dans l’appel à SetWriterFailure.

Dans tous les cas où une défaillance se produit, la méthode doit écrire un événement dans le journal des événements pour signaler la raison exacte de l’échec.

Remarques

L’implémentation par défaut de cette méthode par la classe de base CVssWriter retourne true sans effectuer d’autre opération.

Si des opérations spéciales doivent être effectuées par l’enregistreur lors de l’arrêt d’une application de sauvegarde, l’implémentation par défaut peut être remplacée.

Si aucun cliché instantané n’a été correctement effectué, la valeur de l’identificateur du jeu de cliché instantané (SnapshotSetId) est NULL.

Un événement BackupShutdown est généré chaque fois qu’une application de sauvegarde se termine réellement et que ses IVssBackupComponents sont libérés .

L’événement BackupComplete nécessite que l’application de sauvegarde termine correctement la sauvegarde ou échoue correctement ; Cela peut ne pas être le cas si l’application de sauvegarde est arrêtée par le système ou arrêtée manuellement avant la fin de la sauvegarde (pour instance, si l’opération de sauvegarde a été suspendue et a dû être arrêtée).

Pour cette raison, un événement BackupShutdown est un signal plus robuste de la fin d’une application de sauvegarde que l’événement BackupComplete .

Un enregistreur doit conserver les informations d’état afin qu’il puisse suivre si un événement BackupComplete a été envoyé pour un jeu de cliché instantané donné.

Toute implémentation spécifique à l’auteur de OnBackupShutdown doit case activée si un événement BackupComplete a été géré. Il doit s’assurer que toutes les opérations de nettoyage de l’enregistreur nécessaires à la suite d’une sauvegarde (réussie ou non) sont préformées.

Les rédacteurs ne doivent jamais lever d’exception à cette méthode ou à toute autre méthode de rappel CVssWriter(Ex)::On Xxx .

Si cette méthode appelle la méthode CVssWriterEx2::GetSessionId, CVssWriter::SetWriterFailure ou CVssWriterEx2::SetWriterFailureEx , elle doit le faire dans le même thread qui a appelé cette méthode. Pour plus d’informations, consultez Gestion des événements writer.

Configuration requise

Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	vswriter.h (inclure Vss.h, VsWriter.h)
Bibliothèque	VssApi.lib

Voir aussi

CVssWriter

CVssWriter::OnBackupComplete

CVssWriter::SetWriterFailure

IVssBackupComponents::BackupComplete