Méthode IVssBackupComponentsEx ::GetWriterMetadataEx (vsbackup.h)

  • Article

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

Syntaxe

HRESULT GetWriterMetadataEx(
  [in]  UINT                        iWriter,
  [out] VSS_ID                      *pidInstance,
  [out] IVssExamineWriterMetadataEx **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 la méthode IVssBackupComponents ::GetWriterMetadataCount .

[out] pidInstance

Adresse d’une variable allouée par l’appelant qui reçoit l’identificateur instance de l’enregistreur qui a collecté les métadonnées.

[out] ppMetadata

Pointeur doublement indirect vers le instance de l’objet IVssExamineWriterMetadataEx 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 IVssExamineWriterMetadataEx .
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 paramètre iWriter ne pointe pas vers un writer valide.
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

GetWriterMetadataEx est identique à la méthode IVssBackupComponents ::GetWriterMetadata , sauf qu’elle renvoie un pointeur d’interface IVssExamineWriterMetadataEx au lieu d’un pointeur d’interface IVssExamineWriterMetadata dans le paramètre ppMetadata .

Un demandeur doit appeler la méthode asynchrone IVssBackupComponents ::GatherWriterMetadata et attendre qu’elle se termine avant d’appeler GetWriterMetadataEx.

Bien que la méthode GatherWriterMetadata doit être appelée avant une opération de restauration ou de sauvegarde, GetWriterMetadataEx 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 de la méthode IVssExamineWriterMetadata ::GetComponent , où l’interface IVssExamineWriterMetadataEx a été retournée par GetWriterMetadataEx, 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 des appels à la méthode IVssBackupComponents ::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 Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008, Windows Server 2003 avec SP1 [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 ::GetWriterMetadata

IVssBackupComponentsEx

IVssExamineWriterMetadata

IVssExamineWriterMetadataEx