ホーム › UI.TextServices › ITfContextKeyEventSink

ITfContextKeyEventSink

COM

📘 Microsoft Learn (日本語) · English

IID0552ba5d-c835-4934-bf50-846aaa67432f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfContextKeyEventSink インターフェイスは、入力コンテキスト内で発生するキーボードイベントの通知を受け取るために、テキストサービスが実装します。

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT OnKeyDown(WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfContextKeyEventSink::OnKeyDown メソッド

wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYDOWN の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、前回のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYDOWN の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーストロークが処理されたかどうかを、戻り時に示す BOOL 値へのポインターです。この値が TRUE を受け取った場合、キーイベントは処理されています。この値が FALSE の場合、キーイベントは処理されていません。

戻り値

このメソッドは次の値のいずれかを返します。

値	説明
S_OK	メソッドは成功しました。

vtbl 4 HRESULT OnKeyUp(WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfContextKeyEventSink::OnKeyUp メソッド

wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYUP の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、前回のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYUP の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーストロークが処理されたかどうかを、戻り時に示す BOOL 値へのポインターです。この値が TRUE を受け取った場合、キーイベントは処理されています。この値が FALSE を受け取った場合、キーイベントは処理されていません。

戻り値

このメソッドは次の値のいずれかを返します。

値	説明
S_OK	メソッドは成功しました。

vtbl 5 HRESULT OnTestKeyDown(WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfContextKeyEventSink::OnTestKeyDown メソッド

wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYDOWN の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、前回のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYDOWN の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーストロークが処理されたかどうかを、戻り時に示す BOOL 値へのポインターです。この値が TRUE を受け取った場合、キーイベントは処理されます。この値が FALSE の場合、キーイベントは処理されません。

戻り値

このメソッドは次の値のいずれかを返します。

値	説明
S_OK	メソッドは成功しました。

vtbl 6 HRESULT OnTestKeyUp(WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfContextKeyEventSink::OnTestKeyUp メソッド

wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYUP の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、前回のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYUP の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーストロークが処理されたかどうかを、戻り時に示す BOOL 値へのポインターです。この値が TRUE を受け取った場合、キーイベントは処理されます。この値が FALSE を受け取った場合、キーイベントは処理されません。

戻り値

このメソッドは次の値のいずれかを返します。

値	説明
S_OK	メソッドは成功しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITfContextKeyEventSink "{0552BA5D-C835-4934-BF50-846AAA67432F}"
#usecom global ITfContextKeyEventSink IID_ITfContextKeyEventSink "{}"
#comfunc global ITfContextKeyEventSink_OnKeyDown      3 sptr,sptr,var
#comfunc global ITfContextKeyEventSink_OnKeyUp        4 sptr,sptr,var
#comfunc global ITfContextKeyEventSink_OnTestKeyDown  5 sptr,sptr,var
#comfunc global ITfContextKeyEventSink_OnTestKeyUp    6 sptr,sptr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfContextKeyEventSink "{0552BA5D-C835-4934-BF50-846AAA67432F}"
#usecom global ITfContextKeyEventSink IID_ITfContextKeyEventSink "{}"
#comfunc global ITfContextKeyEventSink_OnKeyDown      3 sptr,sptr,sptr
#comfunc global ITfContextKeyEventSink_OnKeyUp        4 sptr,sptr,sptr
#comfunc global ITfContextKeyEventSink_OnTestKeyDown  5 sptr,sptr,sptr
#comfunc global ITfContextKeyEventSink_OnTestKeyUp    6 sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。