IVssCreateWriterMetadata::AddFilesToFileGroup-Methode (vswriter.h)

Artikel
08/27/2023

Die AddFilesToFileGroup-Methode fügt einer angegebenen Dateigruppenkomponente einen Dateisatz (eine angegebene Datei oder Dateien) hinzu.

Syntax

HRESULT AddFilesToFileGroup(
  [in] LPCWSTR wszLogicalPath,
  [in] LPCWSTR wszGroupName,
  [in] LPCWSTR wszPath,
  [in] LPCWSTR wszFilespec,
  [in] bool    bRecursive,
  [in] LPCWSTR wszAlternateLocation,
  [in] DWORD   dwBackupTypeMask
);

Parameter

[in] wszLogicalPath

Zeiger auf eine mit NULL endende Breitzeichenzeichenfolge, die den logischen Pfad (der NULL sein kann) der Komponente enthält, der die Dateien hinzugefügt werden sollen. Weitere Informationen finden Sie unter Logische Pfade von Komponenten.

[in] wszGroupName

Zeiger auf eine mit NULL endende Breitzeichenzeichenfolge, die den Namen der Dateigruppenkomponente enthält. Der Typ dieser Komponente muss VSS_CT_FILEGROUP sein. Andernfalls gibt die -Methode einen Fehler zurück.

[in] wszPath

Zeiger auf eine mit NULL endende Breitzeichenzeichenfolge, die das Standardstammverzeichnis der hinzuzufügenden Dateien enthält.

Das Verzeichnis kann ein lokales Verzeichnis auf dem VSS-Computer oder ein Dateifreigabeverzeichnis auf einem Remotedateiserver sein.

UNC-Pfade werden unterstützt.

Der Pfad kann Umgebungsvariablen (z. B. %SystemRoot%) enthalten, darf aber keine Wildcardzeichen enthalten.

Es ist nicht erforderlich, dass der Pfad mit einem umgekehrten Schrägstrich ("") endet. Es ist an Anwendungen, die diese Informationen abrufen, um sie zu überprüfen.

[in] wszFilespec

Zeiger auf eine mit NULL endende Breitzeichenzeichenfolge, die die Dateispezifikation der einzufüge- igen Dateien enthält.

Eine Dateispezifikation kann keine Verzeichnisspezifikationen enthalten (z. B. keine umgekehrten Schrägstriche), sondern das ? und * Wildcardzeichen.

[in] bRecursive

Ein boolescher Wert, der angibt, ob der vom wszPath-Parameter angegebene Pfad nur ein einzelnes Verzeichnis identifiziert oder ob er eine Hierarchie von Verzeichnissen angibt, die rekursiv durchlaufen werden sollen. Dieser Parameter sollte auf TRUE festgelegt werden, wenn der Pfad als Eine Hierarchie von Verzeichnissen behandelt wird, durch die rekursiert werden soll, oder andernfalls false .

Informationen zum Durchlaufen von eingebundenen Ordnern finden Sie unter Arbeiten mit eingebundenen Ordnern und Analysepunkten.

[in] wszAlternateLocation

Zeiger auf eine mit NULL endende Breitzeichenzeichenfolge, die den alternativen Pfad enthält, der tatsächlich die Dateien enthält, die mit dieser Komponente gesichert werden sollen.

Das Verzeichnis kann ein lokales Verzeichnis auf dem VSS-Computer oder ein Dateifreigabeverzeichnis auf einem Remotedateiserver sein.

UNC-Pfade werden unterstützt.

Die Angabe eines alternativen Pfads ist optional. Wenn kein alternativer Pfad erforderlich ist, sollte wszAlternatePathNULL sein.

Ein alternativer Pfad sollte nicht mit einer alternativen Standortzuordnung verwechselt werden.

[in] dwBackupTypeMask

Eine Bitmaske mit VSS_FILE_SPEC_BACKUP_TYPE Enumerationswerten, um anzugeben, ob ein Writer die Datei für die Teilnahme an einer bestimmten Art von Sicherungsvorgängen auswerten soll.

Der Standardwert für dieses Argument ist (VSS_FSBT_ALL_BACKUP_REQUIRED | VSS_FSBT_ALL_SNAPSHOT_REQUIRED).

Rückgabewert

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

Wert	Bedeutung
S_OK 0x00000000L	Der Vorgang wurde durchgeführt.
E_INVALIDARG 0x80070057L	Einer der Parameterwerte ist ungültig, oder der Aufrufer hat versucht, Dateigruppendateien zu einer Nicht-Dateigruppen-Komponente hinzuzufügen.
E_OUTOFMEMORY 0x8007000EL	Der Aufrufer verfügt über nicht genügend Arbeitsspeicher oder andere Systemressourcen.
VSS_E_INVALID_XML_DOCUMENT 0x80042311L	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_NOT_SUPPORTED 0x8004232FL	Für Express Writer muss der Wert von wszAlternatePathNULL sein, und die dwBackupTypeMask-Bitmaske kann VSS_FSBT_DIFFERENTIAL_BACKUP_REQUIRED, VSS_FSBT_INCREMENTAL_BACKUP_REQUIRED oder VSS_FSBT_LOG_BACKUP_REQUIRED nicht enthalten.
VSS_E_OBJECT_NOT_FOUND 0x80042308L	Die angegebene Komponente 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

Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008, Windows XP und Windows Server 2003: Remotedateifreigaben werden erst unterstützt, wenn Windows 8 und Windows Server 2012. Writer unterstützen nur lokale Ressourcen– Gruppen von Dateien, deren absoluter Pfad mit einer gültigen lokalen Volumespezifikation beginnt und kein zugeordnetes Netzlaufwerk sein kann. Daher müssen Pfadeingaben (wszPath und wszAlternatePath) zu AddFilesToFileGroup (nach der Auflösung aller Umgebungsvariablen) dieses Format aufweisen.

Ein Writer kann diese Methode mehrmals aufrufen, um seiner Dateigruppenkomponente mehrere Dateien hinzuzufügen. Sie sollten jedoch sicherstellen, dass sich die Dateispezifikationen nicht überlappen, da eine bestimmte Datei nur einmal angegeben werden kann.

Die Speicherorte, von denen Dateien gesichert und in denen sie wiederhergestellt werden, hängen von den Werten für das durch wszPath definierte Stammverzeichnis und den alternativen Pfad ab, der von wszAlternatePath definiert wird.

Beachten Sie Folgendes, wenn Sie pfadinformationen verwenden, die von AddFilesToFileGroup bereitgestellt werden:

Wiederherstellungsvorgänge sollten (wenn möglich) Dateien wiederherstellen, die einer Komponente von AddFilesToFileGroup unter dem standardmäßigen Stammverzeichnis hinzugefügt wurden, das von wszPath definiert ist.
Wenn kein alternativer Pfad angegeben wird (wenn wszAlternatePathNULL ist), werden die der Komponente hinzugefügten Dateien aus dem Standardstammverzeichnis gesichert und im Standardstammverzeichnis wiederhergestellt, das von wszPath angegeben wird.
Wenn ein alternativer Pfad angegeben wird (wenn wszAlternatePath nicht NULL ist), werden dateien, die der Komponente hinzugefügt werden, aus dem alternativen Pfad gesichert, der von wszAlternatePath angegeben wird. Anforderer verwenden jedoch weiterhin wszPath als Standardspeicherort für die Wiederherstellung.
Wenn der alternative Pfad definiert ist (wszAlternatePath ist ungleich NULL) und Dateien vorhanden sind, die der Dateispezifikation (wszFilespec) sowohl im alternativen Pfad als auch im Standardstammverzeichnis (wszPath) entsprechen, sollte ein Sicherungsvorgang Dateien sichern, die sich unter dem alternativen Pfad befinden, und keine Dateien, die sich im Standardstammverzeichnis befinden.
Dateien sollten in dem von wszPath angegebenen Verzeichnis wiederhergestellt werden, es sei denn, eine alternative Speicherortzuordnung wurde von IVssCreateWriterMetadata::AddAlternateLocationMapping festgelegt, und die Wiederherstellungsmethode oder das Wiederherstellungsziel erfordert dies.

Weitere Informationen zu Sicherungs- und Wiederherstellungsdateispeicherorten unter VSS finden Sie unter Nicht standardmäßige Sicherungs- und Wiederherstellungsspeicherorte.

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

IVssCreateWriterMetadata

IVssCreateWriterMetadata::AddAlternateLocationMapping