ホーム › UI.TextServices › ITfCompartment

ITfCompartment

COM

📘 Microsoft Learn (日本語) · English

IIDbb08f7a9-607a-4384-8623-056892b64371継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfCompartment インターフェイスは TSF マネージャーによって実装され、クライアント (アプリケーションおよびテキストサービス) が TSF コンパートメント内のデータを取得・設定するために使用します。

メソッド 2

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

vtbl 3 HRESULT SetValue(DWORD tid, VARIANT* pvarValue)

ITfCompartment::SetValue メソッド

tid	DWORD	in	クライアントを識別する TfClientId 値を格納します。
pvarValue	VARIANT*	in	設定するデータを格納した VARIANT 構造体へのポインターです。使用できるデータ型は VT_I4、VT_UNKNOWN、VT_BSTR のみです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	原因不明のエラーが発生しました。
E_INVALIDARG	pvarValue が無効です。
E_UNEXPECTED	コンパートメントが ITfCompartmentMgr::ClearCompartment の呼び出しによってクリアされている、このメソッドが ITfCompartmentEventSink::OnChange 通知の処理中に呼び出された、またはこのコンパートメントは所有者のみがクリアできます。

vtbl 4 HRESULT GetValue(VARIANT* pvarValue)

ITfCompartment::GetValue メソッド

pvarValue

VARIANT*

out

データを受け取る VARIANT 構造体へのポインターです。コンパートメントに値がない場合は VT_EMPTY を受け取ります。呼び出し元は、このデータが不要になった時点で VariantClear を呼び出して解放する必要があります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
S_FALSE	コンパートメントに値がありません。pvarValue は VT_EMPTY を受け取ります。
E_UNEXPECTED	コンパートメントが ITfCompartmentMgr::ClearCompartment の呼び出しによってクリアされています。
E_INVALIDARG	pvarValue が無効です。

解説(Remarks)

呼び出し元は、データを使用するためにそのデータ形式を把握している必要があります。コンパートメントのインストーラーは、他のクライアントが利用できるようにデータ形式を公開する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfCompartment "{BB08F7A9-607A-4384-8623-056892B64371}"
#usecom global ITfCompartment IID_ITfCompartment "{}"
#comfunc global ITfCompartment_SetValue  3 int,var
#comfunc global ITfCompartment_GetValue  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ITfCompartment "{BB08F7A9-607A-4384-8623-056892B64371}"
#usecom global ITfCompartment IID_ITfCompartment "{}"
#comfunc global ITfCompartment_SetValue  3 int,sptr
#comfunc global ITfCompartment_GetValue  4 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。