Fungsi CfSetPinState (cfapi.h)

Ini mengatur status pin tempat penampung, yang digunakan untuk mewakili niat pengguna. Aplikasi apa pun (bukan hanya penyedia sinkronisasi) yang dapat memanggil fungsi ini.

Sintaks

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

Parameter

[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 akan 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. PinFlags dapat diatur ke nilai berikut:

• Jika CF_PIN_FLAG_RECURSE ditentukan, platform menerapkan status pin ke FileHandle dan setiap file secara rekursif di bawahnya (hanya relevan jika FileHandle adalah handel ke direktori).
• Jika CF_PIN_FLAG_RECURSE_ONLY ditentukan, platform menerapkan status pin ke setiap file secara rekursif di bawah FileHandle, tetapi tidak untuk FileHandle itu sendiri.
• Jika CF_PIN_FLAG_RECURSE_STOP_ERROR ditentukan, platform akan menghentikan rekursi saat mengalami kesalahan pertama. Jika tidak, platform melewati kesalahan dan melanjutkan rekursi.

[in, out, optional] Overlapped

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

Menampilkan nilai

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

Keterangan

Ketika ditentukan dan dikombinasikan dengan FileHandle asinkron, Tumpang tindih memungkinkan platform untuk melakukan panggilan secara asinkron.

Penelepon harus menginisialisasi struktur yang tumpang tindih dengan peristiwa untuk menunggu. Jika ini mengembalikan HRESULT_FROM_WIN32(ERROR_IO_PENDING), pemanggil kemudian dapat menunggu menggunakan GetOverlappedResult. Jika tidak ditentukan, platform akan melakukan panggilan API secara sinkron, terlepas dari bagaimana handel dibuat.

Persyaratan

Lihat juga

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS