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