Metode ITfKeystrokeMgr::P reserveKey (msctf.h)

Artikel
03/08/2023

Mendaftarkan kunci yang dipertahankan.

Sintaks

HRESULT PreserveKey(
  [in] TfClientId            tid,
  [in] REFGUID               rguid,
  [in] const TF_PRESERVEDKEY *prekey,
  [in] const WCHAR           *pchDesc,
  [in] ULONG                 cchDesc
);

Parameter

[in] tid

Berisi pengidentifikasi klien layanan teks TSF. Nilai ini diteruskan ke layanan teks TSF dalam metode ITfTextInputProcessor::Activate .

[in] rguid

Berisi PERINTAH GUID kunci yang dipertahankan. Nilai ini diteruskan ke layanan teks TSF metode ITfKeyEventSink::OnPreservedKey untuk mengidentifikasi kunci yang dipertahankan saat kunci yang dipertahankan diaktifkan.

[in] prekey

Penunjuk ke struktur TF_PRESERVEDKEY yang menentukan kunci yang dipertahankan. Anggota uVKey berisi kode kunci virtual dan anggota uModifiers mengidentifikasi pengubah kunci yang dipertahankan.

[in] pchDesc

Penunjuk ke string Unicode yang berisi deskripsi kunci yang dipertahankan. Ini tidak boleh NULL kecuali cchDesc nol.

[in] cchDesc

Menentukan jumlah karakter dalam pchDesc. Berikan nol untuk parameter ini jika tidak ada deskripsi yang diperlukan.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
TF_E_ALREADY_EXISTS	Kunci yang dipertahankan terdaftar.
E_INVALIDARG	Satu atau beberapa parameter tidak valid.
E_OUTOFMEMORY	Terjadi kesalahan alokasi memori.
E_FAIL	Terjadi kesalahan yang tidak ditentukan.

Keterangan

Kunci yang dipertahankan didaftarkan oleh layanan teks TSF dan menyediakan pintasan keyboard ke perintah umum yang diterapkan oleh layanan teks TSF.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistribusi	TSF 1.0 di Windows 2000 Professional