ITextStoreACP::Metode RequestLock (textstor.h)
Metode ITextStoreACP::RequestLock dipanggil oleh manajer TSF untuk menyediakan kunci dokumen untuk memodifikasi dokumen. Metode ini memanggil metode ITextStoreACPSink::OnLockGranted untuk membuat kunci dokumen.
Sintaks
HRESULT RequestLock(
[in] DWORD dwLockFlags,
[out] HRESULT *phrSession
);
Parameter
[in] dwLockFlags
Menentukan jenis kunci yang diminta.
[out] phrSession
Jika permintaan kunci sinkron, menerima nilai HRESULT dari metode ITextStoreAnchorSink::OnLockGranted yang menentukan hasil permintaan kunci.
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 |
---|---|
|
Metode berhasil. |
|
Terjadi kesalahan yang tidak ditentukan. |
Keterangan
Metode ini menggunakan metode ITextStoreACPSink::OnLockGranted untuk mengunci dokumen. Aplikasi tidak boleh mengubah dokumen atau mengirim pemberitahuan perubahan menggunakan metode ITextStoreACPSink::OnTextChange dari dalam metode ITextStoreACP::RequestLock . Jika aplikasi telah menunggu perubahan pada laporan, aplikasi hanya dapat merespons permintaan kunci asinkron.
Aplikasi tidak boleh mencoba mengantre beberapa panggilan metode ITextStoreACP::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 ITextStoreACP::RequestLock kembali, parameter phrSession akan menerima HRESULT yang dikembalikan oleh metode ITextStoreACPSink::OnLockGranted . Jika panggilan berhasil, tetapi kunci akan diberikan nanti, parameter phrSession menerima bendera TS_S_ASYNC. Parameter phrSession harus diabaikan jika ITextStoreACP::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 2000 Professional [hanya aplikasi desktop] |
Server minimum yang didukung | Windows 2000 Server [hanya aplikasi desktop] |
Target Platform | Windows |
Header | textstor.h |
DLL | Msctf.dll |
Redistribusi | TSF 1.0 di Windows 2000 Professional |