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

La méthode OnPrepareBackup est appelée par un enregistreur à la suite d’un événement PrepareForBackup . Cette méthode est utilisée pour configurer l’état d’un enregistreur et ses composants en préparation d’une opération de sauvegarde.

OnPrepareBackup 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 OnPrepareBackup(
  [in] IVssWriterComponents *pComponent
);

Paramètres

[in] pComponent

Pointeur vers une instanciation d’un objet IVssWriterComponents contenant le contenu du document de métadonnées writer. La valeur de ce paramètre peut être NULL si le demandeur ne prend pas en charge les composants (si CVssWriter ::AreComponentsSelected retourne false).

Valeur retournée

Comme implémenté par la classe de base, OnPrepareBackup 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.

OnPrepareBackup offre à un rédacteur l’occasion de sélectionner plus finement ce qui sera sauvegardé.

La gestion de l’événement PrepareForBackup est la dernière occasion pour un rédacteur d’accéder aux métadonnées contenues dans le document des composants de sauvegarde avant la création du cliché instantané.

Par conséquent, OnPrepareBackup offre la possibilité à l’enregistreur d’apporter des ajouts ou des mises à jour finaux aux informations de composant stockées (à l’aide de l’interface IVssComponent ). En particulier, les métadonnées spécifiques au rédacteur peuvent être mises à jour par IVssComponent ::SetBackupMetadata ou IVssComponent ::SetRestoreMetadata.

En outre, lors de la gestion de l’événement PrepareForSnapshot offre une autre possibilité dans le cycle de vie d’une opération de sauvegarde VSS d’effectuer des opérations chronophages (telles que la synchronisation des données entre plusieurs sites), OnPrepareBackup offre la possibilité au rédacteur de démarrer une telle opération de manière asynchrone. Ces tâches doivent être effectuées avant le retour de CVssWriter ::OnPrepareSnapshot.

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

Un demandeur génère un événement PrepareForBackup , déclenchant un appel à OnPrepareBackup, en appelant IVssBackupComponents ::P repareForBackup.

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

Condition requise	Valeur
Client minimal pris en charge	Windows XP [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 ::OnPostSnapshot

CVssWriter ::OnPreRestore

CVssWriter ::SetWriterFailure

IVssWriterComponents