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

ITfSource

COM
IID4ea48a35-60ae-446f-8fd6-e6a8d82459f7継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfSource インターフェイスは TSF マネージャーによって実装されます。アプリケーションやテキストサービスが、アドバイズシンクのインストールおよびアンインストールを行うために使用します。

解説(Remarks)

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

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

ITfThreadMgr


HRESULT hr;
ITfSource *pSource;

hr = pThreadManager->QueryInterface(IID_ITfSource, (LPVOID*)&pSource);
if(SUCCEEDED(hr))
{
    //ITfSource インターフェイスを使用します。
    
    pSource->Release();
}

ITfContext


HRESULT hr;
ITfSource *pSource;

hr = pContext->QueryInterface(IID_ITfSource, (LPVOID*)&pSource);
if(SUCCEEDED(hr))
{
    //ITfSource インターフェイスを使用します。
    
    pSource->Release();
}

ITfCompartment


HRESULT hr;
ITfSource *pSource;

hr = pCompartmentManager->QueryInterface(IID_ITfSource, (LPVOID*)&pSource);
if(SUCCEEDED(hr))
{
    //ITfSource インターフェイスを使用します。
    
    pSource->Release();
}

ITfInputProcessorProfiles


HRESULT hr;
ITfSource *pSource;

hr = pProfiles->QueryInterface(IID_ITfSource, (LPVOID*)&pSource);
if(SUCCEEDED(hr))
{
    //ITfSource インターフェイスを使用します。
    
    pSource->Release();
}

ITfLangBarItem


HRESULT hr;
ITfSource *pSource;

hr = pLangBarItem->QueryInterface(IID_ITfSource, (LPVOID*)&pSource);
if(SUCCEEDED(hr))
{
    //ITfSource インターフェイスを使用します。
    
    pSource->Release();
}

メソッド 2

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

vtbl 3 HRESULT AdviseSink(GUID* riid, IUnknown* punk, DWORD* pdwCookie)

ITfSource::AdviseSink メソッド

riidGUID*in

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

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

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

意味
IID_ITfActiveLanguageProfileNotifySink
ITfActiveLanguageProfileNotifySink アドバイズシンクをインストールします。
IID_ITfDisplayAttributeNotifySink
ITfDisplayAttributeNotifySink アドバイズシンクをインストールします。
IID_ITfKeyTraceEventSink
ITfKeyTraceEventSink アドバイズシンクをインストールします。
IID_ITfPreservedKeyNotifySink
ITfPreservedKeyNotifySink アドバイズシンクをインストールします。
IID_ITfThreadFocusSink
ITfThreadFocusSink アドバイズシンクをインストールします。
IID_ITfThreadMgrEventSink
ITfThreadMgrEventSink アドバイズシンクをインストールします。
punkIUnknown*inアドバイズシンクの IUnknown ポインター。
pdwCookieDWORD*out識別用のクッキーを受け取る DWORD 値のアドレス。この値は、後続の ITfSource::UnadviseSink の呼び出しでアドバイズシンクをアンインストールする際に使用します。失敗した場合は (DWORD)-1 を受け取ります。

戻り値

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

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

ITfSource::UnadviseSink メソッド

dwCookieDWORDinアンインストールするアドバイズシンクを識別する DWORD 値。この値は、以前の ITfSource::AdviseSink の呼び出しによって提供されます。

戻り値

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

説明
S_OK
メソッドは成功しました。
E_INVALIDARG
dwCookie の値が無効です。
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_ITfSource "{4EA48A35-60AE-446F-8FD6-E6A8D82459F7}"
#usecom global ITfSource IID_ITfSource "{}"
#comfunc global ITfSource_AdviseSink    3 var,sptr,var
#comfunc global ITfSource_UnadviseSink  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。