ITfSourceSingle

COM

IID73131f9c-56a9-49dd-b0ee-d046633f7528継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfSourceSingle インターフェイスは TSF マネージャーによって実装されます。

解説(Remarks)

TSF マネージャーは、ITfSourceSingle インターフェイスの取得方法に応じて、異なる実装の ITfSourceSingle を提供します。実装ごとの違いは、そのインターフェイスでインストールできるアドバイズシンクの種類です。それぞれの実装は、次のオブジェクトから取得できます。

各実装でインストールできるアドバイズシンクの詳細については、ITfSourceSingle::AdviseSingleSink を参照してください。

例

ITfThreadMgr


HRESULT hr;
ITfSourceSingle *pSourceSingle;

hr = pThreadManager->QueryInterface(IID_ITfSourceSingle, (LPVOID*)&pSourceSingle);
if(SUCCEEDED(hr))
{
    //Use the ITfSourceSingle interface. 
    
    pSourceSingle->Release();
}

ITfContext


HRESULT hr;
ITfSourceSingle *pSourceSingle;

hr = pContext->QueryInterface(IID_ITfSourceSingle, (LPVOID*)&pSourceSingle);
if(SUCCEEDED(hr))
{
    //Use the ITfSourceSingle interface. 
    
    pSourceSingle->Release();
}

メソッド 2

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

vtbl 3 HRESULT AdviseSingleSink(DWORD tid, GUID* riid, IUnknown* punk)

ITfSourceSingle::AdviseSingleSink メソッド

tid

DWORD

クライアントを識別する TfClientId 値を格納します。

riid

GUID*

インストールするアドバイズシンクの種類を指定します。

ITfSourceSingle オブジェクトを ITfThreadMgr オブジェクトから取得した場合、このパラメーターには次の値のいずれかを指定できます。

ITfSourceSingle オブジェクトを ITfContext オブジェクトから取得した場合、このパラメーターには次の値のいずれかを指定できます。

値	意味
IID_ITfCleanupContextDurationSink	ITfCleanupContextDurationSink アドバイズシンクをインストールします。
IID_ITfFunctionProvider	クライアントを関数プロバイダーとして登録します。punk パラメーターは ITfFunctionProvider インターフェイスポインターです。

punk

IUnknown*

アドバイズシンクの IUnknown ポインターへのポインター。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
CONNECT_E_CANNOTCONNECT	アドバイズシンクをインストールできません。
CONNECT_E_ADVISELIMIT	アドバイズシンクの最大数に達しました。
E_FAIL	不明なエラーが発生しました。
E_OUTOFMEMORY	メモリ割り当てに失敗しました。

vtbl 4 HRESULT UnadviseSingleSink(DWORD tid, GUID* riid)

ITfSourceSingle::UnadviseSingleSink メソッド

tid

DWORD

クライアントを識別する TfClientId 値を格納します。

riid

GUID*

アンインストールするアドバイズシンクの種類を指定します。次の値のいずれかを指定できます。

値	意味
IID_ITfCleanupContextDurationSink	ITfCleanupContextDurationSink アドバイズシンクをアンインストールします。適用対象: テキストサービス
IID_ITfCleanupContextSink	ITfCleanupContextSink アドバイズシンクをアンインストールします。適用対象: テキストサービス
IID_ITfFunctionProvider	クライアントの関数プロバイダーとしての登録を解除します。適用対象: テキストサービスおよびアプリケーション

戻り値

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

値	説明
S_OK	アドバイズシンクは正常にアンインストールされました。
E_INVALIDARG	tid が無効です。
CONNECT_E_NOCONNECTION	アドバイズシンクがインストールされていません。

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