IVssCreateExpressWriterMetadata::AddComponent-Methode (vswriter.h)

Artikel
08/27/2023

Fügt dem Satz der zu sichernden Komponenten eines Express Writers eine Dateigruppe hinzu.

Syntax

HRESULT AddComponent(
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszCaption,
  [in] const BYTE         *pbIcon,
  [in] UINT               cbIcon,
  [in] bool               bRestoreMetadata,
  [in] bool               bNotifyOnBackupComplete,
  [in] bool               bSelectable,
  [in] bool               bSelectableForRestore,
  [in] DWORD              dwComponentFlags
);

Parameter

[in] ct

Ein VSS_COMPONENT_TYPE Enumerationswert, der den Typ der Komponente angibt. Für diesen Parameter wird nur VSS_CT_FILEGROUP unterstützt.

[in] wszLogicalPath

Ein Zeiger auf eine mit NULL beendete breite Zeichenfolge, die den logischen Pfad der Datenbank oder Dateigruppe enthält. Weitere Informationen finden Sie unter Logisches Pathing von Komponenten.

Dieser Parameter ist optional und kann NULL sein.

[in] wszComponentName

Ein Zeiger auf eine mit NULL beendete breite Zeichenfolge, die den Namen der Komponente enthält. Diese Zeichenfolge ist nicht lokalisiert.

Dieser Parameter ist erforderlich und darf nicht NULL sein. Die Zeichenfolge darf keine umgekehrten Schrägstriche enthalten.

[in] wszCaption

Ein Zeiger auf eine mit NULL beendete breite Zeichenfolge, die eine Beschreibung (auch als "Anzeigename" bezeichnet) für die Komponente enthält. Diese Zeichenfolge kann lokalisiert sein, und daher müssen die Anforderer davon ausgehen, dass sie lokalisiert ist.

Dieser Parameter ist optional und kann NULL sein. Die Zeichenfolge kann umgekehrte Schrägstriche enthalten.

[in] pbIcon

Ein Zeiger auf eine Bitmap des Symbols, das die Datenbank darstellt, die in einer Benutzeroberfläche angezeigt werden soll. Die Größe des Puffers in Bytes wird durch den cbIcon-Parameter angegeben.

Dieser Parameter ist optional und kann NULL sein.

[in] cbIcon

Die Größe des Cookies in Bytes. Wenn der pbIcon-ParameterNULL ist, muss cbIcon 0 sein.

[in] bRestoreMetadata

Dieser Parameter ist für die zukünftige Verwendung reserviert und sollte immer auf false festgelegt werden.

[in] bNotifyOnBackupComplete

Dieser Parameter ist für die zukünftige Verwendung reserviert und sollte immer auf false festgelegt werden.

[in] bSelectable

Ein boolescher Wert, der angibt, ob die Komponente optional gesichert werden kann (was bedeutet, dass sie aus der Sicherung ausgeschlossen werden kann) oder immer gesichert wird, wenn eine der Komponenten des Writers gesichert wird. Dieser Parameter sollte auf festgelegt werden.
true , wenn die Komponente selektiv gesichert werden kann, oder false , wenn die Komponente gesichert wird, wenn eine der Komponenten gesichert wird.

[in] bSelectableForRestore

Ein boolescher Wert, der bestimmt, ob eine Komponente einzeln wiederhergestellt werden kann, wenn sie nicht explizit in das Sicherungsdokument eingeschlossen wurde. Wenn die Komponente explizit dem Sicherungsdokument hinzugefügt wurde, kann sie für die Wiederherstellung immer einzeln ausgewählt werden. in diesem Fall hat dieses Flag keine Bedeutung.

Wenn dieser Parameter true ist, kann die Komponente selbst wiederhergestellt werden. wenn false, kann die Komponente nur wiederhergestellt werden, wenn der gesamte Komponentensatz wiederhergestellt wird. (Weitere Informationen finden Sie unter VSS_COMPONENTINFO und Arbeiten mit Auswählbarkeit und logischen Pfaden.)

Der Standardwert für diesen Parameter ist false.

[in] dwComponentFlags

Eine Bitmaske mit VSS_COMPONENT_FLAGS Enumerationswerten, die die von dieser Komponente unterstützten Features angibt. Diese Bitmaske kann keine VSS_CF_APP_ROLLBACK_RECOVERY oder VSS_CF_BACKUP_RECOVERY enthalten.

Der Standardwert für diesen Parameter ist 0.

Rückgabewert

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

Wert	Bedeutung
S_OK	Der Vorgang wurde durchgeführt.
E_INVALIDARG	Einer der Parameterwerte ist ungültig.
E_OUTOFMEMORY	Der Aufrufer verfügt nicht über 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.
VSS_E_OBJECT_ALREADY_EXISTS	Das Objekt ist ein Duplikat. Eine Komponente mit demselben logischen Pfad und Komponentennamen ist bereits 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

Diese Methode kann mehrmals aufgerufen werden, um den Metadaten eines Express writer mehrere Komponenten hinzuzufügen.

Die Kombination aus logischem Pfad und Name für jede Komponente eines angegebenen instance einer angegebenen Writerklasse muss eindeutig sein. Der Versuch, AddComponent zweimal mit denselben Werten wie wszLogicalPath und wszComponentName aufzurufen, führt zu einem VSS_E_OBJECT_ALREADY_EXISTS Fehler.

AddComponent kann verwendet werden, um Unterkomponenten hinzuzufügen– Komponenten, in denen alle Memberdateien als Gruppe gesichert werden, aber Dateien enthalten, die einzeln wiederhergestellt werden können. Weitere Informationen finden Sie unter Arbeiten mit Auswählbarkeit für Wiederherstellung und Unterkomponenten.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	vswriter.h (einschließlich Vss.h, VsWriter.h)
Bibliothek	VssApi.lib

Weitere Informationen

IVssCreateExpressWriterMetadata

Freigeben über