Méthode IVssSoftwareSnapshotProvider ::GetSnapshotProperties (vsprov.h)

  • Article

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 de cliché instantané.

[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 est chargé de définir les membres de cette structure. Tous les membres sont obligatoires, sauf m_pwszExposedName et m_pwszExposedPath, que le fournisseur peut définir sur NULL. Le fournisseur 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, l’appelant 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 informations demandées ont été retournées avec succè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 plus de mémoire ou d’autres ressources système.
VSS_E_OBJECT_NOT_FOUND
 Le volume spécifié est introuvable.
VSS_E_PROVIDER_VETO
 Erreur du fournisseur. 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.

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

Condition requise Valeur
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 vsprov.h
Bibliothèque VssApi.lib

Voir aussi

IVssSoftwareSnapshotProvider

VssFreeSnapshotProperties