ホーム › UI.Shell › IFrameworkInputPane

IFrameworkInputPane

COM

📘 Microsoft Learn (日本語) · English

IID5752238b-24f0-495a-82f1-2fd593056796継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アプリが入力ペインの状態変化や位置を通知されるようにするメソッドを提供します。

解説(Remarks)

実装するタイミング

このインターフェイスは実装しないでください。実装は Windows により CLSID_FrameworkInputPane として提供されます。

メソッド 4

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

vtbl 3 HRESULT Advise(IUnknown* pWindow, IFrameworkInputPaneHandler* pHandler, DWORD* pdwCookie)

入力ペインをトリガーするイベントが発生したときに、ウィンドウに代わって通知を受け取るためのアプリの入力ペインハンドラーオブジェクトを登録します。このメソッドは、ICoreWindow を実装するオブジェクトを介してウィンドウを参照する点で AdviseWithHWND と異なります。

pWindow	IUnknown*	in	ハンドラーが入力ペインのイベントを待ち受ける対象のウィンドウ(ICoreWindow を実装するオブジェクト)へのポインター。
pHandler	IFrameworkInputPaneHandler*	in	このアプリのハンドラーインスタンスへの IFrameworkInputPaneHandler インターフェイスポインター。
pdwCookie	DWORD*	out	このメソッドが正常に返ったときに、後で Unadvise メソッドを通じてハンドラーの登録を解除するために使用できるクッキーを受け取る値へのポインター。

戻り値

型: HRESULT

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

vtbl 4 HRESULT AdviseWithHWND(HWND hwnd, IFrameworkInputPaneHandler* pHandler, DWORD* pdwCookie)

入力ペインをトリガーするイベントが発生したときに、ウィンドウに代わって通知を受け取るためのアプリの入力ペインハンドラーオブジェクトを登録します。このメソッドは、HWND を介してウィンドウを参照する点で Advise と異なります。

hwnd	HWND	in	ハンドラーが入力ペインのイベントを待ち受ける対象のウィンドウのハンドル。
pHandler	IFrameworkInputPaneHandler*	in	このアプリのハンドラーインスタンスへの IFrameworkInputPaneHandler インターフェイスポインター。
pdwCookie	DWORD*	out	このメソッドが正常に返ったときに、後で Unadvise メソッドを通じてハンドラーの登録を解除するために使用できるクッキーを受け取る値へのポインター。

戻り値

型: HRESULT

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

vtbl 5 HRESULT Unadvise(DWORD dwCookie)

アプリの入力ペインハンドラーオブジェクトの登録を解除し、以後通知を受け取らないようにします。

dwCookie

DWORD

ハンドラーを識別するクッキー。この値は、Advise メソッドを通じてハンドラーを登録した際に取得されたものです。

戻り値

型: HRESULT

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

vtbl 6 HRESULT Location(RECT* prcInputPaneScreenLocation)

入力ペインの現在の位置を取得します。

prcInputPaneScreenLocation

RECT*

out

このメソッドが正常に返ったときに、入力ペインの位置をスクリーン座標で受け取る RECT 構造体へのポインター。入力ペインが表示されていない場合、この構造体は空の矩形を受け取ります。

戻り値

型: HRESULT

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFrameworkInputPane "{5752238B-24F0-495A-82F1-2FD593056796}"
#usecom global IFrameworkInputPane IID_IFrameworkInputPane "{D5120AA3-46BA-44C5-822D-CA8092C1FC72}"
#comfunc global IFrameworkInputPane_Advise          3 sptr,sptr,var
#comfunc global IFrameworkInputPane_AdviseWithHWND  4 sptr,sptr,var
#comfunc global IFrameworkInputPane_Unadvise        5 int
#comfunc global IFrameworkInputPane_Location        6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IFrameworkInputPane "{5752238B-24F0-495A-82F1-2FD593056796}"
#usecom global IFrameworkInputPane IID_IFrameworkInputPane "{D5120AA3-46BA-44C5-822D-CA8092C1FC72}"
#comfunc global IFrameworkInputPane_Advise          3 sptr,sptr,sptr
#comfunc global IFrameworkInputPane_AdviseWithHWND  4 sptr,sptr,sptr
#comfunc global IFrameworkInputPane_Unadvise        5 int
#comfunc global IFrameworkInputPane_Location        6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。