CfHydratePlaceholder-Funktion (cfapi.h)

Artikel
02/28/2024

Hydratisiert eine Platzhalterdatei, indem sichergestellt wird, dass der angegebene Bytebereich auf dem Datenträger im Platzhalter vorhanden ist. Dies gilt nur für Dateien.

Syntax

HRESULT CfHydratePlaceholder(
  [in]                HANDLE           FileHandle,
  [in]                LARGE_INTEGER    StartingOffset,
  [in]                LARGE_INTEGER    Length,
  [in]                CF_HYDRATE_FLAGS HydrateFlags,
  [in, out, optional] LPOVERLAPPED     Overlapped
);

Parameter

[in] FileHandle

Handle der Platzhalterdatei, die hydratisiert werden soll. Ein Attribut oder kein Zugriffshandle ist ausreichend.

[in] StartingOffset

Der Startpunktoffset der Platzhalterdateidaten.

[in] Length

Die Länge der Platzhalterdatei in Bytes, deren Daten lokal auf dem Datenträger verfügbar sein müssen, nachdem die API erfolgreich abgeschlossen wurde. Eine Länge von CF_EOF (definiert als -1) bedeutet das Ende der Datei. Für alle Unterbereiche, die nicht im Platzhalter vorhanden sind, ruft die Plattform die Daten vom Synchronisierungsanbieter ab und speichert sie auf dem Datenträger im Platzhalter.

[in] HydrateFlags

Die Platzhalterhydrierungsflags. HydrateFlags muss auf CF_HYDRATE_FLAG_NONE festgelegt werden.

[in, out, optional] Overlapped

Bei Angabe und Kombination mit einem asynchronen FileHandle ermöglicht Overlapped der Plattform die asynchrone Ausführung des CfHydratePlaceholder-Aufrufs . Weitere Informationen finden Sie in den Anmerkungen .

Falls nicht angegeben, führt die Plattform den API-Aufruf synchron aus, unabhängig davon, wie das Handle erstellt wurde.

Rückgabewert

Wenn diese Funktion erfolgreich ist, wird zurückgegeben S_OK. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Der Aufrufer muss READ_DATA oder WRITE_DAC Zugriff auf den Platzhalter haben, um hydriert zu werden.

Wenn die API bei asynchroner Verwendung von OverlappedHRESULT_FROM_WIN32(ERROR_IO_PENDING) zurückgibt, kann der Aufrufer mit GetOverlappedResult warten.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 10, Version 1709 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2016 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	cfapi.h
Bibliothek	CldApi.lib
DLL	CldApi.dll

Weitere Informationen

GetOverlappedResult

Freigeben über