ITextStoreACP2::Metode RequestLock (textstor.h)

Artikel
03/02/2024

Dipanggil oleh manajer TSF untuk menyediakan kunci dokumen untuk mengubah dokumen. Metode ini memanggil metode OnLockGranted untuk membuat kunci dokumen.

Sintaks

HRESULT RequestLock(
  [in]  DWORD   dwLockFlags,
  [out] HRESULT *phrSession
);

Parameter

[in] dwLockFlags

Menentukan jenis kunci yang diminta.

Nilai	Makna
TS_LF_READ	Dokumen memiliki kunci baca-saja dan tidak dapat dimodifikasi.
TS_LF_READWRITE	Dokumen memiliki kunci baca/tulis dan dapat dimodifikasi.
TS_LF_SYNC	Dokumen memiliki kunci sinkron jika bendera ini digabungkan dengan bendera lain.

[out] phrSession

Jika permintaan kunci sinkron, menerima nilai HRESULT dari metode OnLockGranted yang menentukan hasil permintaan penguncian.

Jika permintaan kunci tidak sinkron dan hasilnya TS_S_ASYNC, dokumen menerima kunci asinkron. Jika permintaan kunci tidak sinkron dan hasilnya TS_E_SYNCHRONOUS, dokumen tidak dapat dikunci secara sinkron.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
E_FAIL	Terjadi kesalahan yang tidak ditentukan.

Keterangan

Metode ini menggunakan metode OnLockGranted untuk mengunci dokumen. Aplikasi tidak boleh mengubah dokumen atau mengirim pemberitahuan perubahan menggunakan metode OnTextChange dari dalam metode RequestLock . Jika aplikasi telah menunggu perubahan pada laporan, aplikasi hanya dapat merespons permintaan kunci asinkron.

Aplikasi tidak boleh mencoba mengantre beberapa panggilan metode RequestLock , karena aplikasi hanya memerlukan satu panggilan balik. Namun, jika penelepon membuat beberapa permintaan baca dan satu atau beberapa permintaan tulis, panggilan balik harus untuk akses tulis.

Permintaan yang berhasil untuk kunci sinkron menggantikan permintaan untuk kunci asinkron. Permintaan yang tidak berhasil untuk kunci sinkron tidak menggantikan permintaan untuk kunci asinkron. Implementasi harus tetap melayani permintaan asinkron yang luar biasa, jika ada.

Jika kunci diberikan sebelum metode RequestLock kembali, parameter phrSession akan menerima HRESULT yang dikembalikan oleh metode OnLockGranted . Jika panggilan berhasil, tetapi kunci akan diberikan nanti, parameter phrSession menerima bendera TS_S_ASYNC. Parameter phrSession harus diabaikan jika RequestLock mengembalikan apa pun selain S_OK.

Penelepon tidak boleh memanggil metode ini secara menyeluruh, kecuali jika penelepon memegang kunci baca-saja. Dalam hal ini metode dapat dipanggil secara reentrantly untuk meminta kunci tulis asinkron. Kunci tulis akan diberikan nanti, setelah kunci baca-saja berakhir.

Untuk informasi selengkapnya tentang kunci dokumen, lihat Kunci Dokumen.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8 [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2012 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	textstor.h
DLL	Msctf.dll