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

Article
03/03/2024

La méthode GetWriterMetadata retourne les métadonnées d’un writer spécifique en cours d’exécution sur le système.

Syntaxe

HRESULT GetWriterMetadata(
  [in]  UINT                      iWriter,
  [out] VSS_ID                    *pidInstance,
  [out] IVssExamineWriterMetadata **ppMetadata
);

Paramètres

[in] iWriter

Index du writer dont les métadonnées doivent être récupérées. La valeur de ce paramètre est un entier compris entre 0 et n–1 inclus, où n est le nombre total d’enregistreurs sur le système actuel. La valeur n est retournée par IVssBackupComponents ::GetWriterMetadataCount.

[out] pidInstance

Pointeur vers l’identificateur instance de l’enregistreur qui a collecté les métadonnées.

[out] ppMetadata

Pointeur doublement indirect vers le instance de l’objet IVssExamineWriterMetadata qui contient les métadonnées retournées.

Valeur retournée

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

Valeur	Signification
S_OK	Retour réussi d’un pointeur vers un objet d’interface IVssExamineWriterMetadata .
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_BAD_STATE	L’objet de composants de sauvegarde n’est pas initialisé, cette méthode a été appelée pendant une opération de restauration ou cette méthode n’a pas été appelée dans la séquence correcte.
VSS_E_INVALID_XML_DOCUMENT	Le document XML n’est pas valide. Pour plus d’informations, consultez le journal des événements. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.
VSS_E_OBJECT_NOT_FOUND	Le cliché instantané spécifié n’existe pas.
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

Un demandeur doit appeler l’opération asynchrone IVssBackupComponents ::GatherWriterMetadata et attendre qu’elle se termine avant d’appeler GetWriterMetadata.

Bien que IVssBackupComponents ::GatherWriterMetadata doit être appelé avant une opération de restauration ou de sauvegarde, GetWriterMetadata n’est généralement pas appelé pour les restaurations.

Les informations de composant récupérées (pendant les opérations de sauvegarde) à l’aide d’IVssExamineWriterMetadata ::GetComponent, où l’interface IVssExamineWriterMetadata a été retournée par GetWriterMetadata, proviennent du document de métadonnées writer d’un processus d’écriture dynamique.

Cela contraste avec les informations retournées par GetWriterComponents (pendant les opérations de restauration), qui ont été stockées dans le document composants de sauvegarde par les appels à AddComponent.

Lorsque l’appelant de cette méthode a terminé d’accéder aux métadonnées, il doit appeler IUnknown ::Release.

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