ホーム › UI.TextServices › ITfFnReconversion

ITfFnReconversion

COM

IID4cea93c0-0a58-11d3-8df0-00105a2799b5継承元ITfFunction自前メソッド開始 vtbl4

公式ドキュメント

ITfFnReconversion インターフェイスはテキストサービスによって実装され、テキストサービスが提供するテキストの再変換をサポートするために TSF マネージャーまたはクライアントから使用されます。

解説(Remarks)

テキストサービスがテキストをコンテキストに挿入する前にそのテキストを解釈しなければならない場合、解釈が複数通り考えられることがあります。音声入力はその一例です。発話された語が "there" であった場合、"their" や "they're" という解釈もあり得ます。テキストサービスは最も適切と思われるテキストを挿入しますが、それでも誤りが生じる可能性は残ります。テキストの再変換とは、挿入されたテキストに対して別のテキストをユーザーが選択できるようにする処理のことです。

メソッド 3

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

vtbl 4 HRESULT QueryRange(ITfRange* pRange, ITfRange** ppNewRange, BOOL* pfConvertable)

ITfFnReconversion::QueryRange メソッドは、再変換の対象となるテキストの範囲(レンジ)を取得します。

pRange

ITfRange*

再変換対象のテキストの全体または一部を含む ITfRange オブジェクトへのポインター。

ppNewRange

ITfRange**

inout

[in, out] 再変換可能なテキスト全体を含む範囲オブジェクトを受け取る ITfRange ポインターへのポインター。pRange が含むテキストがいずれも再変換できない場合、このパラメーターは NULL を受け取ります。この場合でもメソッドは S_OK を返すため、呼び出し元はポインターを使用する前にこのパラメーターが NULL でないことを確認する必要があります。

このメソッドがテキストサービスによって実装される場合、このパラメーターは省略可能であり、NULL にできます。この場合、範囲は不要です。

TSF マネージャーによる実装が呼び出される場合、このパラメーターは省略できず、NULL にはできません。

pfConvertable

BOOL*

out

pRange が含むテキストがいずれも再変換できない場合は 0 を、それ以外の場合は 0 以外の値を受け取る BOOL 値へのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

vtbl 5 HRESULT GetReconversion(ITfRange* pRange, ITfCandidateList** ppCandList)

ITfFnReconversion::GetReconversion メソッド

pRange	ITfRange*	in	再変換対象のテキストを含む ITfRange オブジェクトへのポインター。この範囲オブジェクトは ITfFnReconversion::QueryRange を呼び出して取得します。
ppCandList	ITfCandidateList**	out	候補一覧オブジェクトを受け取る ITfCandidateList ポインターへのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

vtbl 6 HRESULT Reconvert(ITfRange* pRange)

ITfFnReconversion::Reconvert メソッド

pRange

ITfRange*

再変換対象のテキストを含む ITfRange オブジェクトへのポインター。この範囲オブジェクトを取得するには ITfFnReconversion::QueryRange を呼び出します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

解説(Remarks)

このメソッドがダイアログボックスなどの何らかのユーザーインターフェイスを表示する場合、その UI が閉じられるのを待ってから戻ってはなりません。

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