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

ITfInputScope

COM
IIDfde1eaee-6924-4cdf-91e7-da38cff5559d継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfInputScope インターフェイスは、テキスト入力プロセッサが、ウィンドウに関連付けられたドキュメントコンテキストを表す InputScope の値を取得するために使用します。

解説(Remarks)

このインターフェイスをウィンドウを持たないコントロールで使用する場合、アプリケーションには 2 つの選択肢があります。

  1. アプリケーションを TSF 対応にする: TSF 対応のアプリケーションは、ITfInputScope へのポインターを取得するために、ITextStoreACP または ITfContextOwner のいずれかを実装する必要があります。
  2. SetInputScopes この方法は推奨されませんが、アプリケーションが TSF 対応でない場合、入力スコープとアプリケーションの関連付けを維持する手段は他にありません。この場合、アプリケーションはウィンドウを持たないコントロール間でフォーカスが変わるたびに SetInputScopes を呼び出す必要があります。

メソッド 5

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

vtbl 3 HRESULT GetInputScopes(InputScope** pprgInputScopes, DWORD* pcCount)

ITfInputScope::GetInputScopes メソッド

pprgInputScopesInputScope**out入力スコープへのポインターの配列を指すポインター。呼び出し側の関数は、バッファーを解放するために CoTaskMemFree() を呼び出す必要があります。
pcCountDWORD*out返された入力スコープの数を受け取るポインター。

戻り値

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

説明
S_OK
メソッドは成功しました。
vtbl 4 HRESULT GetPhrase(LPWSTR** ppbstrPhrases, DWORD* pcCount)

ITfInputScope::GetPhrase メソッド

ppbstrPhrasesLPWSTR**outフレーズを格納した文字列へのポインターの配列を指すポインター。呼び出し側の関数は、文字列に割り当てられたメモリを解放するために SystFreeString() を、バッファーを解放するために CoTaskMemFree を呼び出す必要があります。
pcCountDWORD*out返されたフレーズの数を受け取るポインター。

戻り値

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

説明
S_OK
メソッドは成功しました。
vtbl 5 HRESULT GetRegularExpression(LPWSTR* pbstrRegExp)

ITfInputScope::GetRegularExpression メソッド

pbstrRegExpLPWSTR*out正規表現を格納した文字列へのポインター。呼び出し側の関数は、文字列に割り当てられたメモリを解放するために SystFreeString() を呼び出す必要があります。

戻り値

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

説明
S_OK
メソッドは成功しました。
vtbl 6 HRESULT GetSRGS(LPWSTR* pbstrSRGS)

ITfInputScope::GetSRGS メソッド

pbstrSRGSLPWSTR*outXML 文字列。呼び出し側の関数は、バッファーを解放するために SysFreeString() を呼び出す必要があります。

戻り値

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

説明
S_OK
メソッドは成功しました。

解説(Remarks)

http://www.w3.org/TR/speech-grammar

vtbl 7 HRESULT GetXML(LPWSTR* pbstrXML)

ITfInputScope::GetXML メソッド

pbstrXMLLPWSTR*outXML 文字列を格納した文字列へのポインター。呼び出し側の関数は、バッファーを解放するために SysFreeString() を呼び出す必要があります。

戻り値

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

説明
S_OK
メソッドは成功しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfInputScope "{FDE1EAEE-6924-4CDF-91E7-DA38CFF5559D}"
#usecom global ITfInputScope IID_ITfInputScope "{}"
#comfunc global ITfInputScope_GetInputScopes        3 var,var
#comfunc global ITfInputScope_GetPhrase             4 var,var
#comfunc global ITfInputScope_GetRegularExpression  5 var
#comfunc global ITfInputScope_GetSRGS               6 var
#comfunc global ITfInputScope_GetXML                7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。