IVssComponent::GetPartialFile-Methode (vswriter.h)

Die GetPartialFile-Methode gibt Informationen zu einer partiellen Datei zurück, die dieser Komponente zugeordnet ist.

Syntax

HRESULT GetPartialFile(
  [in]  UINT iPartialFile,
  [out] BSTR *pbstrPath,
  [out] BSTR *pbstrFilename,
  [out] BSTR *pbstrRange,
  [out] BSTR *pbstrMetadata
);

Parameter

[in] iPartialFile

Indexnummer der partiellen Datei. Der Wert dieses Parameters ist eine ganze Zahl von 0 bis einschließlich n–1, wobei n die Gesamtanzahl der Teildateien ist, die einer bestimmten Komponente zugeordnet sind. Der Wert von n wird von IVssComponent::GetPartialFileCount zurückgegeben.

[out] pbstrPath

Zeiger auf eine Zeichenfolge, die den Pfad der Teildatei enthält.

Benutzer dieser Methode müssen überprüfen, ob dieser Pfad mit einem umgekehrten Schrägstrich ("") endet.

[out] pbstrFilename

Zeiger auf eine Zeichenfolge, die den Namen der Teildatei enthält.

[out] pbstrRange

Ein Zeiger auf eine Zeichenfolge, die entweder eine Auflistung von Dateioffsets und Längen enthält, die den teiliellen Dateiunterstützungsbereich (die Abschnitte der Datei, die gesichert wurden) oder den Namen einer Datei mit einer solchen Liste enthält.

[out] pbstrMetadata

Zeiger auf eine Zeichenfolge, die alle zusätzlichen Metadaten enthält, die ein Writer zum Überprüfen eines teilweisen Dateiwiederherstellungsvorgangs benötigt. Die Informationen in dieser Metadatenzeichenfolge sind für die Anforderer undurchsichtig.

Zusätzliche Metadaten sind nicht erforderlich, sodass pbstrMetadata auch leer sein kann (Länge null).

Rückgabewert

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

Wert Bedeutung
S_OK
Der Attributwert wurde erfolgreich zurückgegeben.
E_INVALIDARG
Einer der Parameterwerte ist ungültig.
E_OUTOFMEMORY
Der Aufrufer verfügt nicht über Arbeitsspeicher oder andere Systemressourcen.
VSS_E_BAD_STATE
Der Aufrufer befindet sich nicht im richtigen Zustand (Sicherung oder Wiederherstellung) für den Vorgang.
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_NOT_FOUND
Das angegebene Element wurde nicht gefunden.

Hinweise

Der Aufrufer sollte den Arbeitsspeicher der Parameter pbstrPath, pbstrFilename, pbstrRange und pbstrMetadata freigeben, indem SysFreeString aufgerufen wird.

Ein Bereich gibt einen Unterabschnitt einer bestimmten Datei an, die unabhängig vom Rest der Datei gesichert werden soll.

Die Syntax der Bereichsliste (pbstrRanges) ist die einer durch Trennzeichen getrennten Liste des Formulars offset1:length1, offset2:length2, wobei jeder Offset und jede Länge eine ganze 64-Bit-Ganzzahl ist, die einen Byteoffset und eine Länge in Bytes angibt. Der Offset und die Länge können entweder als hexadezimale oder dezimale Werte ausgedrückt werden.

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

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

Eine Bereichsdatei muss eine Binärdatei mit dem 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 ganzen 64-Bit-Zahlen ausgedrückt wird: der Offset in die zu sichernde Datei in Bytes und die Länge der Daten, die ab diesem Offset gesichert werden sollen.
Eine Bereichsdatei sollte zusammen mit der Teildatei gesichert werden und wird in der Regel an demselben Speicherort wiederhergestellt, von dem aus sie gesichert wurde.

Der Speicherort, an dem eine Bereichsdatei wiederhergestellt wird, kann jedoch vom Anforderer geändert werden, der IVssBackupComponents::SetRangesFilePath verwendet, um dies anzugeben und das Sicherungskomponentendokument so zu aktualisieren, dass pbstrRanges die richtige Bereichsdatei angibt.

Ein Anforderer würde die von GetPartialFile zurückgegebenen Bereichsinformationen verwenden, um die gesicherten Abschnitte an dem entsprechenden Speicherort innerhalb der Kopie der Datei auf dem Datenträger zur Wiederherstellungszeit wiederherzustellen.

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 (einschließlich Vss.h, VsWriter.h)
Bibliothek VssApi.lib

Weitere Informationen

IVssBackupComponents::SetRangesFilePath

IVssComponent

IVssComponent::AddPartialFile

IVssComponent::GetPartialFileCount