ITfKeystrokeMgr::P reserveKey メソッド (msctf.h)
保持されているキーを登録します。
構文
HRESULT PreserveKey(
[in] TfClientId tid,
[in] REFGUID rguid,
[in] const TF_PRESERVEDKEY *prekey,
[in] const WCHAR *pchDesc,
[in] ULONG cchDesc
);
パラメーター
[in] tid
TSF テキスト サービスのクライアント識別子を格納します。 この値は、 ITfTextInputProcessor::Activate メソッドの TSF テキスト サービスに渡されます。
[in] rguid
保持されているキーのコマンド GUID を格納します。 この値は TSF テキスト サービス ITfKeyEventSink::OnPreservedKey メソッドに渡され、保持キーがアクティブになったときに保持されるキーを識別します。
[in] prekey
保持されるキーを指定する TF_PRESERVEDKEY 構造体へのポインター。 uVKey メンバーには仮想キー コードが含まれており、uModifiers メンバーは保持されているキーの修飾子を識別します。
[in] pchDesc
保持されているキーの説明を含む Unicode 文字列へのポインター。 cchDesc が 0 でない限り、NULL にすることはできません。
[in] cchDesc
pchDesc の文字数を指定します。 説明が必要ない場合は、このパラメーターに 0 を渡します。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
| 値 | 説明 |
|---|---|
|
メソッドは正常に実行されました。 |
|
保持されているキーが登録されます。 |
|
1 つ以上のパラメーターが無効です。 |
|
メモリ割り当てエラーが発生しました。 |
|
未指定のエラーが発生しました。 |
解説
保持されたキーは TSF テキスト サービスによって登録され、TSF テキスト サービスによって実装される一般的なコマンドへのキーボード ショートカットが提供されます。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | msctf.h |
| [DLL] | Msctf.dll |
| 再頒布可能パッケージ | Windows 2000 Professional 上の TSF 1.0 |
関連項目
ITfKeyEventSink::OnPreservedKey
ITfKeystrokeMgr::UnpreserveKey