Fungsi CfGetTransferKey (cfapi.h)

CfGetTransferKey mengembalikan TransferKey, yang diperlukan untuk memulai transfer data ke tempat penampung menggunakan CfExecute API.

Sintaks

HRESULT CfGetTransferKey(
  [in]  HANDLE          FileHandle,
  [out] CF_TRANSFER_KEY *TransferKey
);

Parameter

[in] FileHandle

Handel file tempat penampung.

[out] TransferKey

Handel buram ke tempat penampung yang akan dilayankan.

Menampilkan nilai

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

Keterangan

API ini tersedia untuk penyedia sinkronisasi yang mungkin ingin secara proaktif memulai transfer data ke tempat penampung, sebagai alternatif untuk memanggil CfHydratePlaceholder. CfGetTransferKey mengembalikan TransferKey yang sama dengan yang akan dikembalikan oleh panggilan balik data pengambilan. Penyedia sinkronisasi kemudian dapat meneruskan TransferKey dalam panggilan berikutnya ke API CfExecute . Dengan cara ini, transfer data didorong oleh penyedia sinkronisasi daripada filter.

Penyedia sinkronisasi harus memiliki akses READ_DATA atau WRITE_DAC ke file yang kunci transfernya akan diperoleh atau CfGetTransferKey akan gagal dengan HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED).

TransferKey berlaku selama FileHandle yang digunakan untuk mendapatkannya tetap terbuka. Penyedia sinkronisasi harus meneruskan TransferKey ke CfExecute untuk melakukan operasi yang diinginkan pada file atau folder tempat penampung. Ketika TransferKey tidak lagi digunakan, TransferKey harus dirilis menggunakan CfReleaseTransferKey.

Persyaratan

Lihat juga

CfHydratePlaceholder

CfExecute

CfReleaseTransferKey