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

マウス イベント シンクをインストールします。

構文

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

パラメーター

[in] range

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

[in] pSink

ITfMouseSink インターフェイスへのポインター。

[out] pdwCookie

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

戻り値

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

説明
S_OK
メソッドは正常に実行されました。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
TF_E_DISCONNECTED
コンテキスト オブジェクトがドキュメント スタック上にありません。
E_NOTIMPL
コンテキスト所有者は、マウス イベント シンクをサポートしていません。
E_FAIL
未指定のエラーが発生しました。

解説

アドバイズ シンクがインストールされている場合、 範囲 で指定された範囲でマウス イベントが発生すると、マウス イベント シンク ITfMouseSink::OnMouseEvent 呼び出しが発生します。

マウス イベント シンクを削除するには、 pdwCookie に配置された値を保存して ITfMouseTracker::UnadviseMouseSink に渡す必要があります。

要件

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

関連項目

ITfMouseSink

ITfMouseSink::OnMouseEvent

ITfMouseTracker

ITfMouseTracker::UnadviseMouseSink

ITfRange