ホーム › UI.TextServices › ITfFnGetLinguisticAlternates

ITfFnGetLinguisticAlternates

COM

📘 Microsoft Learn (日本語) · English

IIDea163ce2-7a65-4506-82a3-c528215da64e継承元ITfFunction自前メソッド開始 vtbl4

公式ドキュメント

ITfFnGetLinguisticAlternates インターフェイスは、テキストサービスまたは TSF マネージャーによって実装され、パラメーターとして渡された範囲(レンジ)内のテキストに対する言語的な代替候補を提供します。

メソッド 1

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

vtbl 4 HRESULT GetAlternates(ITfRange* pRange, ITfCandidateList** ppCandidateList)

指定されたテキスト範囲(レンジ)に対する代替文字列の一覧を返します。

pRange	ITfRange*	in	代替候補を取得する対象のテキストを含む ITfRange オブジェクトへのポインター。
ppCandidateList	ITfCandidateList**	out	代替文字列を格納するリストオブジェクトを受け取る ITfCandidateList ポインターへのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生したか、その範囲(レンジ)に対する代替候補を生成できませんでした。*ppCandidateList には null が返されます。
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_ITfFnGetLinguisticAlternates "{EA163CE2-7A65-4506-82A3-C528215DA64E}"
#usecom global ITfFnGetLinguisticAlternates IID_ITfFnGetLinguisticAlternates "{}"
#comfunc global ITfFnGetLinguisticAlternates_GetAlternates  4 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。