Fungsi CfGetPlaceholderRangeInfo (cfapi.h)

Mendapatkan informasi rentang tentang file atau folder tempat penampung.

Sintaks

HRESULT CfGetPlaceholderRangeInfo(
  [in]            HANDLE                          FileHandle,
  [in]            CF_PLACEHOLDER_RANGE_INFO_CLASS InfoClass,
  [in]            LARGE_INTEGER                   StartingOffset,
  [in]            LARGE_INTEGER                   Length,
  [out]           PVOID                           InfoBuffer,
  [in]            DWORD                           InfoBufferLength,
  [out, optional] PDWORD                          ReturnedLength
);

Parameter

[in] FileHandle

Handel file tempat penampung yang akan dikueri.

[in] InfoClass

Jenis rentang data tempat penampung.

[in] StartingOffset

Offset dari titik awal rentang data.

[in] Length

Panjang rentang data. Penyedia dapat menentukan CF_EOFPanjang untuk menunjukkan bahwa rentang yang informasinya diminta adalah dari StartingOffset ke akhir file.

[out] InfoBuffer

Penunjuk ke buffer yang akan menerima data. Buffer adalah array struktur CF_FILE_RANGE , yang merupakan pasangan offset/panjang, yang menjelaskan rentang yang diminta.

[in] InfoBufferLength

Panjang InfoBuffer dalam byte.

[out, optional] ReturnedLength

Panjang rentang data tempat penampung yang dikembalikan di InfoBuffer.

Nilai kembali

Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan. Beberapa kode kesalahan umum tercantum dalam tabel berikut:

Kode kesalahan	Makna
HRESULT_FROM_WIN32( ERROR_HANDLE_EOF )	Ini berarti bahwa StartingOffset>= posisi akhir file.
HRESULT_FROM_WIN32( ERROR_MORE_DATA )	Ini menyiratkan bahwa entri CF_FILE_RANGE berikutnya tidak sesuai dengan buffer yang disediakan. Penelepon harus memverifikasi apakah ada entri yang diterima atau tidak menggunakan nilai InfoBufferWritten yang dikembalikan.

Keterangan

Tidak seperti kebanyakan API tempat penampung yang mengambil handel file, yang ini tidak memodifikasi file dengan cara apa pun, oleh karena itu handel file hanya memerlukan akses READ_ATTRIBUTES.

Persyaratan

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

CfGetPlaceholderRangeInfoForHydration