ITfMouseTrackerACP::AdviseMouseSink メソッド (msctf.h)

マウス イベント シンクをインストールするために呼び出されます。

構文

HRESULT AdviseMouseSink(
  [in]  ITfRangeACP  *range,
  [in]  ITfMouseSink *pSink,
  [out] DWORD        *pdwCookie
);

パラメーター

[in] range

マウス シンクがインストールされているテキストの範囲を指定する ITfRange インターフェイスへのポインター。

[in] pSink

ITfMouseSink インターフェイスへのポインター。 アプリケーションでは、このオブジェクト参照数をインクリメントし、インターフェイスを保存する必要があります。

[out] pdwCookie

マウス イベント シンクを識別する Cookie を受け取る DWORD へのポインター。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

説明
S_OK
メソッドは正常に実行されました。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
E_NOTIMPL
アプリケーションでは、マウス イベント シンクはサポートされていません。

解説

このアドバイス シンクがインストールされると、 範囲 で指定された範囲にマウス イベントが発生すると、マウス イベント シンク ITfMouseSink::OnMouseEvent メソッドが呼び出されます。

pdwCookie に配置された値は呼び出し元によって保存され、マウス イベント シンクを削除するために ITfMouseTrackerACP::UnadviseMouseSink メソッドに渡されます。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー msctf.h
[DLL] Msctf.dll
再頒布可能パッケージ Windows 2000 Professional 上の TSF 1.0

関連項目

ITfMouseSink

ITfMouseSink::OnMouseEvent

ITfMouseTrackerACP

ITfMouseTrackerACP::UnadviseMouseSink

ITfRange