Fungsi CfHydratePlaceholder (cfapi.h)

Menghidrasi file tempat penampung dengan memastikan bahwa rentang byte yang ditentukan ada di disk di tempat penampung. Ini hanya berlaku untuk file.

Sintaks

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

Menangani file tempat penampung yang akan dihidrasi. Atribut atau handel tanpa akses sudah cukup.

[in] StartingOffset

Offset titik awal data file tempat penampung.

[in] Length

Panjang, dalam byte, dari file tempat penampung yang datanya harus tersedia secara lokal pada disk setelah API berhasil diselesaikan. Panjang CF_EOF (didefinisikan sebagai -1) menandakan akhir file. Untuk subrange apa pun yang tidak ada di tempat penampung, platform akan mengambil data dari penyedia sinkronisasi dan menyimpannya di disk di tempat penampung.

[in] HydrateFlags

Bendera hidrasi tempat penampung. HydrateFlags harus diatur ke CF_HYDRATE_FLAG_NONE.

[in, out, optional] Overlapped

Ketika ditentukan dan dikombinasikan dengan FileHandle asinkron, Tumpang tindih memungkinkan platform untuk melakukan panggilan CfHydratePlaceholder secara asinkron. Lihat Keterangan untuk detail selengkapnya.

Jika tidak ditentukan, platform akan melakukan panggilan API secara sinkron, terlepas dari bagaimana handel dibuat.

Nilai kembali

Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Penelepon harus memiliki akses READ_DATA atau WRITE_DAC ke tempat penampung yang akan dihidrasi.

Jika API mengembalikan HRESULT_FROM_WIN32(ERROR_IO_PENDING) saat menggunakan Tumpang Tindih secara asinkron, pemanggil kemudian dapat menunggu menggunakan GetOverlappedResult.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 10, versi 1709 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2016 [hanya aplikasi desktop]
Target Platform	Windows
Header	cfapi.h
Pustaka	CldApi.lib
DLL	CldApi.dll

Lihat juga

GetOverlappedResult