IVssComponent::AddPartialFile-Methode (vswriter.h)

  • Artikel

Die AddPartialFile-Methode gibt an, dass nur Teile einer bestimmten Datei gesichert werden sollen und welche Teile dies sind.

Nur ein Writer kann diese Methode aufrufen, und zwar nur während eines Sicherungsvorgangs.

Syntax

HRESULT AddPartialFile(
  [in] LPCWSTR wszPath,
  [in] LPCWSTR wszFilename,
  [in] LPCWSTR wszRanges,
  [in] LPCWSTR wszMetadata
);

Parameter

[in] wszPath

Mit Null beendete Breitzeichenzeichenfolge, die den Pfad der Datei enthält, die an partiellen Dateivorgängen beteiligt ist.

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.

Dieser Pfad sollte mit dem Pfad einer Datei übereinstimmen, die bereits in der Komponente enthalten ist (oder einer ihrer Unterkomponenten, wenn die Komponente einen Komponentensatz definiert).

[in] wszFilename

Mit Null beendete Breitzeichenzeichenfolge, die den Namen der Datei enthält, die an partiellen Dateivorgängen beteiligt ist. Der Name der Datei (wszFilename) darf keine Wildcardzeichen (* oder ?) enthalten und muss mit der Dateispezifikation eines Dateisatzes konsistent sein, der den Quellpfad (wszPath) enthält.

[in] wszRanges

Zeichenfolge mit NULL-Terminierung mit Breitzeichen, die entweder eine Auflistung von Dateioffsets und Längen enthält, die den Teilbereich der Dateiunterstützung bilden (die Abschnitte der Datei, die tatsächlich gesichert werden sollen), oder den Namen einer Datei, die eine solche Liste enthält.

Die Angabe des teilweisen Dateiunterstützungsbereichs ist erforderlich, und dieser Wert darf nicht NULL sein.

[in] wszMetadata

Null-beendete Breitzeichenzeichenfolge, die alle zusätzlichen Metadaten enthält, die von einem Writer zum Überprüfen eines partiellen Dateiwiederherstellungsvorgangs erforderlich sind. Die Informationen in dieser Metadatenzeichenfolge sind für den Anforderer undurchsichtig.

Wenn keine zusätzlichen Metadaten erforderlich sind, kann dieser Wert NULL sein.

Rückgabewert

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

Wert Bedeutung
S_OK
 Das Element wurde 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
 Die -Methode wurde nicht von einem Writer aufgerufen oder, wenn sie von einem Writer aufgerufen wurde, während eines Wiederherstellungsvorgangs nicht aufgerufen.

Hinweise

Nur ein Writer kann diese Methode aufrufen, und der Writer kann diese Methode während eines Wiederherstellungsvorgangs nicht aufrufen.

Die Syntax der Bereichsauflistung (wszRanges) ist die einer durch Trennzeichen getrennten Liste der Form offset1:length1, offset2:length2, wobei jeder Offset und die Länge eine 64-Bit-Ganzzahl ist, die einen Byteoffset bzw. eine Länge in Bytes angibt. Der Offset und die Länge können entweder als Hexadezimal- oder Dezimalwerte ausgedrückt werden.

Wenn wszRange auf eine Datei verweist, die alle Offsets und Längen (eine Bereichsdatei) enthält , enthält wszRange nur den vollständigen Pfad zur Datei.

Eine Bereichsdatei muss eine Binärdatei im folgenden Format sein:

  1. Eine 64-Bit-Ganzzahl, die die Anzahl unterschiedlicher Dateibereiche angibt, die gesichert werden müssen
  2. Jeder Bereich, der als Paar von 64-Bit-Ganzzahlen ausgedrückt wird: der Offset in die Datei, die in Bytes gesichert wird, und die Länge der Daten, die ab diesem Offset gesichert werden sollen
In beiden Fällen gibt ein Bereich einen Unterabschnitt einer bestimmten Datei an, die unabhängig vom Rest der Datei gesichert werden soll.

Anforderer können die Teildateiinformationen mithilfe von IVssComponent::GetPartialFile abrufen und die von GetPartialFile zurückgegebenen Offset- und Längeninformationen verwenden, um gesicherte Abschnitte am entsprechenden Speicherort innerhalb der Kopie der Datei auf dem Datenträger zum Zeitpunkt der Wiederherstellung wiederherzustellen.

AddPartialFile kann auf eine Datei angewendet werden, die bereits von der Komponente verwaltet wird (oder auf eine ihrer Unterkomponenten, wenn die Komponente einen Komponentensatz definiert), oder es kann der Komponente eine neue Datei hinzufügen und angeben, dass sie an Teildateivorgängen teilnimmt.

Wenn angegeben wird, dass es sich bei der zu beteiligenden Datei um eine neue Datei handelt, muss diese Datei auf einem schattenkopierten Volume vorhanden sein, und ihr Pfad (wszPath) sollte einem Pfad entsprechen, der bereits in der Komponente enthalten ist (oder eine ihrer Unterkomponenten, wenn die Komponente einen Komponentensatz definiert). Die Dateispezifikation der Datei (wszFileSpec) sollte jedoch nicht mit einer datei in den Komponenten übereinstimmen.

Neu hinzugefügte Dateien unterstützen keine alternativen Speicherortzuordnungen.

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

IVssBackupComponents::SetRangesFilePath

IVssComponent

IVssComponent::GetPartialFile

IVssComponent::GetPartialFileCount