Méthode IVssBackupComponents ::D eleteSnapshots (vsbackup.h)

Article
03/03/2024

La méthode DeleteSnapshots supprime un ou plusieurs clichés instantanés ou un jeu de clichés instantanés.

Syntaxe

HRESULT DeleteSnapshots(
  [in]  VSS_ID          SourceObjectId,
  [in]  VSS_OBJECT_TYPE eSourceObjectType,
  [in]  BOOL            bForceDelete,
  [out] LONG            *plDeletedSnapshots,
  [out] VSS_ID          *pNondeletedSnapshotID
);

Paramètres

[in] SourceObjectId

Identificateur du cliché instantané ou d’un jeu de clichés instantanés à supprimer.

[in] eSourceObjectType

Type de l’objet sur lequel tous les clichés instantanés seront supprimés. La valeur de ce paramètre est VSS_OBJECT_SNAPSHOT ou VSS_OBJECT_SNAPSHOT_SET.

[in] bForceDelete

Si la valeur de ce paramètre est TRUE, le fournisseur fera tout son possible pour supprimer le cliché instantané ou les clichés instantanés dans un jeu de clichés instantanés. S’il est FALSE, aucun effort supplémentaire n’est effectué.

[out] plDeletedSnapshots

Nombre de clichés instantanés supprimés.

[out] pNondeletedSnapshotID

Si une erreur se produit, la valeur de ce paramètre est l’identificateur du premier cliché instantané qui n’a pas pu être supprimé. Sinon, c’est GUID_NULL.

Valeur retournée

Voici les codes de retour valides pour cette méthode.

Valeur	Signification
S_OK	Les clichés instantanés ont été supprimés.
E_ACCESSDENIED	L’appelant ne dispose pas de privilèges de sauvegarde suffisants ou n’est pas administrateur.
E_INVALIDARG	L’une des valeurs de paramètre n’est pas valide.
E_OUTOFMEMORY	L’appelant n’a pas de mémoire ou d’autres ressources système.
VSS_E_UNEXPECTED	Erreur inattendue. Le code d’erreur est enregistré dans le fichier journal des erreurs. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS. Windows Server 2008, Windows Vista, Windows Server 2003 et Windows XP : Cette valeur n’est pas prise en charge tant que Windows Server 2008 R2 et Windows 7. E_UNEXPECTED est utilisé à la place.
VSS_E_OBJECT_NOT_FOUND	Le cliché instantané spécifié n’existe pas.
VSS_E_PROVIDER_VETO	Erreur du fournisseur attendue. Le fournisseur a enregistré l’erreur dans le journal des événements. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.
VSS_E_UNEXPECTED_PROVIDER_ERROR	Erreur de fournisseur inattendue. Le code d’erreur est enregistré dans le journal des erreurs. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.

Remarques

Plusieurs clichés instantanés dans un jeu de clichés instantanés sont supprimés séquentiellement. Si une erreur se produit lors de l’une de ces suppressions individuelles, DeleteSnapshots retourne immédiatement ; aucune tentative de suppression des clichés instantanés restants ne sera effectuée. Le VSS_ID du cliché instantané non supprimé est retourné dans pNondeletedSnapshotID.

Le demandeur est responsable de la sérialisation de l’opération de suppression du cliché instantané.

Au cours d’une sauvegarde, les clichés instantanés sont automatiquement libérés dès que les IVssBackupComponents instance sont libérés. Dans ce cas, il n’est pas nécessaire de supprimer explicitement les clichés instantanés.

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	vsbackup.h (inclure VsBackup.h, Vss.h, VsWriter.h)
Bibliothèque	VssApi.lib

Voir aussi

IVssBackupComponents

IVssBackupComponents ::StartSnapshotSet

VSS_ID