IVssBackupComponents::SetBackupOptions-Methode (vsbackup.h)

Artikel
08/27/2023

Die SetBackupOptions-Methode legt eine Zeichenfolge privater oder writerabhängiger Sicherungsparameter für eine Komponente fest.

Syntax

HRESULT SetBackupOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszBackupOptions
);

Parameter

[in] writerId

Writer-ID.

[in] ct

Typ der Komponente. Die möglichen Werte finden Sie unter VSS_COMPONENT_TYPE .

[in] wszLogicalPath

Mit Null beendete Breitzeichenzeichenfolge, die den logischen Pfad der Komponente enthält.

Weitere Informationen finden Sie unter Logische Pfade von Komponenten.

Der Wert der Zeichenfolge, die den hier verwendeten logischen Pfad enthält, sollte dem Wert entsprechen, der verwendet wurde, als die Komponente mithilfe von IVssBackupComponents::AddComponent dem Sicherungssatz hinzugefügt wurde.

Der logische Pfad kann NULL sein.

Es gibt keine Einschränkungen für die Zeichen, die in einem logischen Pfad ohne NULL angezeigt werden können.

[in] wszComponentName

Breitzeichenzeichenfolge mit NULL-Beendigung, die den Namen der Komponente enthält.

Die Zeichenfolge, die den Namen enthält, darf nicht NULL sein und sollte denselben Komponentennamen wie beim Hinzufügen der Komponente zum Sicherungssatz mithilfe von IVssBackupComponents::AddComponent enthalten.

[in] wszBackupOptions

Mit Null beendete Breitzeichenzeichenfolge, die die festzulegenden Sicherungsparameter enthält.

Rückgabewert

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

Wert	Bedeutung
S_OK	Die Sicherungsoptionen wurden erfolgreich festgelegt.
E_INVALIDARG	Einer der Parameterwerte ist ungültig.
E_OUTOFMEMORY	Der Aufrufer verfügt über nicht genügend 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 innerhalb der richtigen Sequenz aufgerufen.
VSS_E_OBJECT_NOT_FOUND	Die Sicherungskomponente ist nicht vorhanden.
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_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

Die genaue Syntax und der Inhalt der Sicherungsoptionen, die vom wszBackupOptions-Parameter der SetBackupOptions-Methode festgelegt werden, hängen vom jeweiligen Writer ab, der kontaktiert wird.

Diese Methode muss vor IVssBackupComponents::P repareForBackup aufgerufen werden.

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

Weitere Informationen

IVssBackupComponents

IVssBackupComponents::P repareForBackup

IVssBackupComponents::SetRestoreOptions

VSS_COMPONENT_TYPE

Freigeben über