ホーム › UI.TextServices › ITfCompartmentMgr

ITfCompartmentMgr

COM

📘 Microsoft Learn (日本語) · English

IID7dcf57ac-18ad-438b-824d-979bffb74b7c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

解説(Remarks)

このインターフェイスが管理するコンパートメントの範囲は、インターフェイスをどのように取得したかによって異なります。このインターフェイスのインスタンスは、次のいずれかの方法で取得できます。詳細については、コンパートメントを参照してください。

ITfThreadMgr::GetGlobalCompartment - グローバルコンパートメントマネージャーを取得します。
ITfThreadMgr::QueryInterface に IID_ITfCompartmentMgr を指定 - 対象のスレッドマネージャーのコンパートメントマネージャーを取得します。
ITfDocumentMgr::QueryInterface に IID_ITfCompartmentMgr を指定 - 対象のドキュメントマネージャーのコンパートメントマネージャーを取得します。
ITfContext::QueryInterface に IID_ITfCompartmentMgr を指定 - 対象のコンテキストのコンパートメントマネージャーを取得します。

メソッド 3

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

vtbl 3 HRESULT GetCompartment(GUID* rguid, ITfCompartment** ppcomp)

ITfCompartmentMgr::GetCompartment メソッド

rguid	GUID*	in	コンパートメントを識別する GUID を指定します。
ppcomp	ITfCompartment**	out	コンパートメントオブジェクトを受け取る ITfCompartment インターフェイスポインターへのポインター。

戻り値

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

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

vtbl 4 HRESULT ClearCompartment(DWORD tid, GUID* rguid)

ITfCompartmentMgr::ClearCompartment メソッド

tid	DWORD	in	クライアントを識別する TfClientId の値を指定します。
rguid	GUID*	in	コンパートメントを識別する GUID を指定します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
CONNECT_E_NOCONNECTION	コンパートメントが見つかりません。
E_FAIL	原因不明のエラーが発生しました。
E_UNEXPECTED	このコンパートメントは所有者がクリアする必要があります。

vtbl 5 HRESULT EnumCompartments(IEnumGUID** ppEnum)

ITfCompartmentMgr::EnumCompartments メソッドは、コンパートメントマネージャー内にあるコンパートメントの GUID を格納した列挙子を取得します。

ppEnum

IEnumGUID**

out

列挙子オブジェクトを受け取る IEnumGUID インターフェイスポインターへのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	原因不明のエラーが発生しました。
E_INVALIDARG	ppcEnum が無効です。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

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