ホーム › UI.TextServices › ITfFunctionProvider

ITfFunctionProvider

COM

IID101d6610-0990-11d3-8df0-00105a2799b5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfFunctionProvider インターフェイスは、各種の関数オブジェクトを提供するために、アプリケーションまたはテキストサービスによって実装されます。

解説(Remarks)

関数プロバイダーは、テキストサービスがアクティブ化されるときに IID_ITfFunctionProvider を指定して ITFSourceSingle::AdviseSingleSink を呼び出すことで登録します。テキストサービスは、非アクティブ化されるときに ITFSourceSingle::UnadviseSingleSink を使用して関数プロバイダーの登録を解除する必要があります。

メソッド 3

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

vtbl 3 HRESULT GetType(GUID* pguid)

ITfFunctionProvider::GetType メソッド

pguid

GUID*

out

関数プロバイダーの種類の識別子を受け取る GUID 値へのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました
E_INVALIDARG	pguid が無効です。

vtbl 4 HRESULT GetDescription(LPWSTR* pbstrDesc)

ITfFunctionProvider::GetDescription メソッド

pbstrDesc

LPWSTR*

out

説明文字列を受け取る BSTR へのポインター。この値は SysAllocString を使用して割り当てる必要があります。呼び出し元は、不要になった時点で SysFreeString を使用してこのメモリを解放する必要があります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。
E_INVALIDARG	pbstrDesc が無効です。

vtbl 5 HRESULT GetFunction(GUID* rguid, GUID* riid, IUnknown** ppunk)

ITfFunctionProvider::GetFunction メソッド

rguid	GUID*	in	要求する関数が属する関数グループを識別する GUID 値を格納します。この値には GUID_NULL を指定できます。
riid	GUID*	in	rguid で指定されたグループ内で、要求する関数を識別するインターフェイス識別子を格納します。この値は、アプリケーションやテキストサービスが指定するもの、または IID_ITfFn* 値のいずれかを指定できます。
ppunk	IUnknown**	out	要求した関数インターフェイスを受け取る IUnknown インターフェイスポインターへのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_NOINTERFACE	要求された関数はサポートされていません。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfFunctionProvider "{101D6610-0990-11D3-8DF0-00105A2799B5}"
#usecom global ITfFunctionProvider IID_ITfFunctionProvider "{}"
#comfunc global ITfFunctionProvider_GetType         3 var
#comfunc global ITfFunctionProvider_GetDescription  4 var
#comfunc global ITfFunctionProvider_GetFunction     5 var,var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfFunctionProvider "{101D6610-0990-11D3-8DF0-00105A2799B5}"
#usecom global ITfFunctionProvider IID_ITfFunctionProvider "{}"
#comfunc global ITfFunctionProvider_GetType         3 sptr
#comfunc global ITfFunctionProvider_GetDescription  4 sptr
#comfunc global ITfFunctionProvider_GetFunction     5 sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。