Bagikan melalui


Fungsi CfGetPlaceholderInfo (cfapi.h)

Mendapatkan berbagai karakteristik file atau folder tempat penampung. Jika file bukan tempat penampung file cloud, API akan gagal. Setelah berhasil, informasi dikembalikan sesuai dengan InfoClass tertentu yang diminta.

Sintaks

HRESULT CfGetPlaceholderInfo(
  [in]            HANDLE                    FileHandle,
  [in]            CF_PLACEHOLDER_INFO_CLASS InfoClass,
  [out]           PVOID                     InfoBuffer,
  [in]            DWORD                     InfoBufferLength,
  [out, optional] PDWORD                    ReturnedLength
);

Parameter

[in] FileHandle

Handel ke tempat penampung yang informasinya akan dikueri. Tidak seperti kebanyakan API file cloud yang mengambil handel file, yang ini tidak memodifikasi file dengan cara apa pun. Oleh karena itu, handel file hanya memerlukan akses READ_ATTRIBUTES .

[in] InfoClass

Informasi tempat penampung. Ini dapat diatur ke CF_PLACEHOLDER_STANDARD_INFO atau CF_PLACEHOLDER_BASIC_INFO.

[out] InfoBuffer

Penunjuk ke buffer yang akan menerima informasi tentang tempat penampung.

[in] InfoBufferLength

Panjang InfoBuffer, dalam byte. Jika buffer tidak cukup besar untuk menyimpan semua informasi yang diminta, API akan mengembalikan data sebanyak yang dapat masuk ke buffer, dan panggilan akan gagal dengan HRESULT_FROM_WIN32(ERROR_MORE_DATA).

[out, optional] ReturnedLength

Jumlah byte yang dikembalikan di InfoBuffer.

Nilai kembali

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

Keterangan

Informasi tempat penampung mencakup atribut berikut:

Atribut Deskripsi
OnDiskDataSize Jumlah total byte pada disk.
ValidatedDataSize Jumlah total byte yang sinkron dengan cloud.
ModifiedDataSize Jumlah total byte yang telah ditimpa/ditambahkan secara lokal, yaitu, tidak sinkron dengan cloud.
PropertiesSize Jumlah total byte pada disk yang digunakan oleh semua blob properti.
PinState Lihat CfSetPinState untuk informasi selengkapnya.
InSyncState Lihat CfSetInSyncState untuk informasi selengkapnya.
FileId Angka non-volatil lebar volume 64-bit yang secara unik mengidentifikasi file atau direktori.
SyncRootFileId ID file direktori akar sinkronisasi tempat file yang informasi tempat penampungnya akan dikueri berada.
FileIdentity Blob buram yang disediakan oleh penyedia sinkronisasi ke platform ketika tempat penampung dibuat. Identitas file disediakan untuk semua panggilan balik penyedia sinkronisasi.
FileIdentityLength Panjang identitas file dalam byte.

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

CfSetPinState

CfSetInSyncState

CF_PLACEHOLDER_STANDARD_INFO

CF_PLACEHOLDER_BASIC_INFO