ITextStoreAnchor::AdviseSink メソッド (textstor.h)

  • [アーティクル]

ITextStoreAnchor::AdviseSink メソッドは、ITextStoreAnchorSink インターフェイスから新しいアドバイズ シンクをインストールするか、既存のアドバイズ シンクを変更します。

構文

HRESULT AdviseSink(
  [in] REFIID   riid,
  [in] IUnknown *punk,
  [in] DWORD    dwMask
);

パラメーター

[in] riid

シンク インターフェイスを指定します。 サポートされている値はIID_ITextStoreAnchorSinkのみです。

[in] punk

アドバイスするシンク インターフェイスへのポインター。 NULL にすることはできません。

[in] dwMask

アドバイズ シンクに通知するイベントを指定します。 使用可能なパラメーター値の詳細については、「 TS_AS_* 定数」を参照してください。

戻り値

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

値 説明
S_OK
 メソッドは正常に実行されました。
E_FAIL
 指定されたシンク インターフェイス riid を取得できませんでした。
E_INVALIDARG
 指定されたシンク インターフェイスはサポートされていません。
E_UNEXPECTED
 指定したシンク オブジェクトを取得できませんでした。

注釈

punk パラメーターで表される同じインターフェイスを持つ後続の呼び出しは、dwMask パラメーターを更新するための要求として処理されます。 サーバーは、このような要求に応答してシンクで AddRef メソッドを呼び出さないでください。

サーバーは 1 つの接続ポイントのみを保持します。 元のシンク オブジェクトが削除されるまで、2 つ目のシンク オブジェクトのエラーを知らそうとします。 通知が不要な場合は、アプリケーションで ITextStoreAnchor::UnadviseSink メソッドを使用してシンク オブジェクトの登録を解除する必要があります。

要件

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

こちらもご覧ください

ITextStoreAnchor

ITextStoreAnchor::UnadviseSink

TS_AS_* 定数