IVssComponent::GetBackupMetadata-Methode (vswriter.h)

  • Artikel

Die GetBackupMetadata-Methode ruft private, writerspezifische Sicherungsmetadaten ab, die möglicherweise während eines PrepareForBackup-Ereignisses von CVssWriter::OnPrepareBackup mithilfe von IVssComponent::SetBackupMetadata festgelegt wurden.

Nur ein Writer kann diese Methode aufrufen.

Syntax

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

Parameter

[out] pbstrData

Die Adresse einer vom Aufrufer zugewiesenen Variablen, die eine Zeichenfolge mit den Sicherungsmetadaten empfängt, die während eines OnPrepareBackup-Ereignisses hinzugefügt wurden.

Rückgabewert

Im Folgenden finden Sie die gültigen Rückgabecodes für diese Methode.

Wert Bedeutung
S_OK
 Der Attributwert wurde erfolgreich zurückgegeben.
S_FALSE
 Dieser Komponente sind keine Sicherungsmetadaten zugeordnet.
E_INVALIDARG
 Einer der Parameterwerte ist ungültig.
E_OUTOFMEMORY
 Der Aufrufer verfügt über nicht genügend Arbeitsspeicher oder andere Systemressourcen.
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.

Hinweise

Diese Methode kann je nach Logik eines bestimmten Writers jederzeit aufgerufen werden.

Wenn keine Sicherungsmetadaten festgelegt wurden, gibt GetBackupMetadata S_FALSE zurück.

Wenn der Aufruf von GetBackupMetadata erfolgreich ist, ist der Aufrufer dafür verantwortlich, die im pbstrMetadata-Parameter zurückgegebene Zeichenfolge durch Aufrufen der SysFreeString-Funktion freizugeben.

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 vswriter.h (enthalten Vss.h, VsWriter.h)
Bibliothek VssApi.lib

Weitere Informationen

IVssComponent

IVssComponent::SetBackupMetadata