IVssBackupComponents::GetWriterMetadata-Methode (vsbackup.h)

Artikel
08/27/2023

Die GetWriterMetadata-Methode gibt die Metadaten für einen bestimmten Writer zurück, der auf dem System ausgeführt wird.

Syntax

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

Parameter

[in] iWriter

Index des Writers, dessen Metadaten abgerufen werden sollen. Der Wert dieses Parameters ist eine ganze Zahl von 0 bis einschließlich n–1, wobei n die Gesamtzahl der Autoren im aktuellen System ist. Der Wert von n wird von IVssBackupComponents::GetWriterMetadataCount zurückgegeben.

[out] pidInstance

Zeiger auf den instance Bezeichner des Writers, der die Metadaten gesammelt hat.

[out] ppMetadata

Doppelt indirekter Zeiger auf die instance des IVssExamineWriterMetadata-Objekts, das die zurückgegebenen Metadaten enthält.

Rückgabewert

Im Folgenden sind die gültigen Rückgabecodes für diese Methode aufgeführt.

Wert	Bedeutung
S_OK	Erfolgreich einen Zeiger auf ein IVssExamineWriterMetadata-Schnittstellenobjekt zurückgegeben.
E_INVALIDARG	Einer der Parameterwerte ist ungültig.
E_OUTOFMEMORY	Der Aufrufer verfügt nicht über Arbeitsspeicher oder andere Systemressourcen.
VSS_E_BAD_STATE	Das Sicherungskomponentenobjekt wird nicht initialisiert, diese Methode wurde während eines Wiederherstellungsvorgangs aufgerufen, oder diese Methode wurde nicht in der richtigen Sequenz aufgerufen.
VSS_E_INVALID_XML_DOCUMENT	Das XML-Dokument ist ungültig. Überprüfen Sie das Ereignisprotokoll auf Details. Weitere Informationen finden Sie unter Ereignis- und Fehlerbehandlung unter VSS.
VSS_E_OBJECT_NOT_FOUND	Die angegebene Schattenkopie ist nicht vorhanden.
VSS_E_UNEXPECTED	Unerwarteter Fehler. Der Fehlercode wird in der Fehlerprotokolldatei protokolliert. Weitere Informationen finden Sie unter Ereignis- und Fehlerbehandlung unter VSS. Windows Server 2008, Windows Vista, Windows Server 2003 und Windows XP: Dieser Wert wird erst unter Windows Server 2008 R2 und Windows 7 unterstützt. stattdessen wird E_UNEXPECTED verwendet.

Hinweise

Ein Anforderer muss den asynchronen Vorgang IVssBackupComponents::GatherWriterMetadata aufrufen und warten, bis er abgeschlossen ist, bevor GetWriterMetadata aufgerufen wird.

Obwohl IVssBackupComponents::GatherWriterMetadata vor einem Wiederherstellungs- oder Sicherungsvorgang aufgerufen werden muss, wird GetWriterMetadata normalerweise nicht für Wiederherstellungen aufgerufen.

Komponenteninformationen, die (bei Sicherungsvorgängen) mithilfe von IVssExamineWriterMetadata::GetComponent abgerufen werden, wobei die IVssExamineWriterMetadata-Schnittstelle von GetWriterMetadata zurückgegeben wurde, stammen aus dem Writer Metadata Document eines Live Writer-Prozesses.

Dies steht im Gegensatz zu den Von GetWriterComponents (während Wiederherstellungsvorgängen) zurückgegebenen Informationen, die durch Aufrufe von AddComponent im Dokument sicherungskomponenten gespeichert wurden.

Wenn der Aufrufer dieser Methode den Zugriff auf die Metadaten abgeschlossen hat, muss er IUnknown::Release aufrufen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	vsbackup.h (einschließlich VsBackup.h, Vss.h, VsWriter.h)
Bibliothek	VssApi.lib