Fungsi CfSetPinState (cfapi.h)

Fungsi ini mengatur status pin tempat penampung, yang mewakili niat pengguna. Aplikasi apa pun, bukan hanya penyedia sinkronisasi, dapat memanggil fungsi ini.

Syntax

HRESULT CfSetPinState(
  [in]                HANDLE           FileHandle,
  [in]                CF_PIN_STATE     PinState,
  [in]                CF_SET_PIN_FLAGS PinFlags,
  [in, out, optional] LPOVERLAPPED     Overlapped
);

Parameter-parameternya

[in] FileHandle

Handel file tempat penampung. Platform ini menyinkronkan operasi dengan benar dengan permintaan aktif lainnya. Atribut atau handel tanpa akses sudah cukup. Pemanggil harus memiliki akses READ_DATA atau WRITE_DAC ke tempat penampung. Jika tidak, operasi gagal dengan STATUS_CLOUD_FILE_ACCESS_DENIED.

[in] PinState

Status pin file tempat penampung. Untuk daftar nilai PinState yang valid, lihat CF_PIN_STATE.

[in] PinFlags

Bendera status pin. Atur PinFlags ke salah satu nilai berikut:

• Jika Anda menentukan CF_SET_PIN_FLAG_RECURSE, platform menerapkan status pin ke FileHandle dan setiap file secara rekursif di bawahnya. Bendera ini hanya relevan jika FileHandle adalah handel ke direktori.
• Jika Anda menentukan CF_SET_PIN_FLAG_RECURSE_ONLY, platform menerapkan status pin ke setiap file secara rekursif di bawah FileHandle, tetapi tidak ke FileHandle itu sendiri.
• Jika Anda menentukan CF_SET_PIN_FLAG_RECURSE_STOP_ON_ERROR, platform akan menghentikan rekursi saat mengalami kesalahan pertama. Jika tidak, platform melewati kesalahan dan melanjutkan rekursi.

Gunakan CF_SET_PIN_FLAG_NONE untuk menentukan tidak ada bendera.

[in, out, optional] Overlapped

Memungkinkan panggilan dilakukan secara asinkron. Lihat bagian Keterangan untuk detail selengkapnya.

Mengembalikan nilai

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

Komentar

Ketika Anda menentukan dan menggabungkan FileHandle asinkron dengan Tumpang Tindih, platform dapat melakukan panggilan secara asinkron.

Anda harus menginisialisasi struktur yang tumpang tindih dengan peristiwa untuk menunggu. Jika fungsi ini mengembalikan HRESULT_FROM_WIN32(ERROR_IO_PENDING), Anda dapat menunggu dengan menggunakan GetOverlappedResult. Jika Anda tidak menentukan parameter ini, platform melakukan panggilan API secara sinkron, terlepas dari bagaimana Anda membuat handel.

Persyaratan

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

Lihat juga

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS