Méthode IVssBackupComponents::GetSnapshotProperties (vsbackup.h)

Article
08/27/2023

La méthode GetSnapshotProperties obtient les propriétés du cliché instantané spécifié.

Syntaxe

HRESULT GetSnapshotProperties(
  [in]  VSS_ID            SnapshotId,
  [out] VSS_SNAPSHOT_PROP *pProp
);

Paramètres

[in] SnapshotId

Identificateur du cliché instantané d’un volume retourné par IVssBackupComponents::AddToSnapshotSet.

[out] pProp

Adresse d’une structure de VSS_SNAPSHOT_PROP allouée à l’appelant qui reçoit les propriétés de cliché instantané. Le fournisseur de logiciels est responsable de la définition des membres de cette structure. Le fournisseur de logiciels alloue de la mémoire pour tous les membres de chaîne qu’il définit dans la structure. Lorsque la structure n’est plus nécessaire, le fournisseur de logiciels est chargé de libérer ces chaînes en appelant la fonction VssFreeSnapshotProperties .

Valeur retournée

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

Valeur	Signification
S_OK	Les propriétés de cliché instantané ont été retournées.
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_BAD_STATE	L’objet de composants de sauvegarde n’est pas initialisé, cette méthode a été appelée lors d’une opération de restauration ou cette méthode n’a pas été appelée dans la séquence correcte.
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	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_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

L’appelant doit définir le contenu de la structure VSS_SNAPSHOT_PROP sur zéro avant d’appeler la méthode GetSnapshotProperties .

Le fournisseur est responsable de l’allocation et de la libération des chaînes dans la structure VSS_SNAPSHOT_PROP .

Configuration requise


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