Win32 API 日本語リファレンス
ホーム › UI.TextServices › ITfPreservedKeyNotifySink

ITfPreservedKeyNotifySink

COM
📘 Microsoft Learn (日本語) · English
IID6f77c993-d2b1-446e-853e-5912efc8a286継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfPreservedKeyNotifySink インターフェイスは、キーが予約 (preserve) されたとき、予約が解除されたとき、または予約キーの説明が変更されたときに通知を受け取るために、アプリケーションまたは TSF テキストサービスによって実装されます。

解説(Remarks)

予約キーとは、アプリケーションまたは TSF テキストサービスが TSF マネージャーに登録できるキーボードショートカットのことです。

メソッド 1

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

vtbl 3 HRESULT OnUpdated(TF_PRESERVEDKEY* pprekey)

ITfPreservedKeyNotifySink::OnUpdated メソッド

pprekeyTF_PRESERVEDKEY*inキーに関するデータを格納する TF_PRESERVEDKEY 構造体へのポインター。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT のエラーコードを返します。

解説(Remarks)

キーの予約が解除されたかどうかを判断するには、pprekey を渡して ITfKeystrokeMgr::IsPreservedKey を呼び出します。キーが見つからない場合、そのキーは予約解除されています。キーが見つかった場合は、予約されているか、説明が変更されたかのいずれかです。現在のキーの説明を保持しておき、この通知に応じて以前の説明と現在の説明を比較しない限り、この通知がキーの予約によるものか説明の変更によるものかを判断する方法はありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfPreservedKeyNotifySink "{6F77C993-D2B1-446E-853E-5912EFC8A286}"
#usecom global ITfPreservedKeyNotifySink IID_ITfPreservedKeyNotifySink "{}"
#comfunc global ITfPreservedKeyNotifySink_OnUpdated  3 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。