Freigeben über


ITextStoreAnchor::AdviseSink-Methode (textstor.h)

Die ITextStoreAnchor::AdviseSink-Methode installiert eine neue Empfehlungssenke über die ITextStoreAnchorSink-Schnittstelle oder ändert eine vorhandene Empfehlungssenke.

Syntax

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

Parameter

[in] riid

Gibt die Senkenschnittstelle an. Der einzige unterstützte Wert ist IID_ITextStoreAnchorSink.

[in] punk

Zeiger auf die Senkenschnittstelle, um sie zu beraten. Kann nicht NULL sein.

[in] dwMask

Gibt die Ereignisse an, die die Empfehlungssenke benachrichtigen. Weitere Informationen zu möglichen Parameterwerten finden Sie unter TS_AS_* Konstanten.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert BESCHREIBUNG
S_OK
Die Methode war erfolgreich.
E_FAIL
Die angegebene Senkeschnittstelle konnte nicht abgerufen werden.
E_INVALIDARG
Die angegebene Senkenschnittstelle wird nicht unterstützt.
E_UNEXPECTED
Das angegebene Senkenobjekt konnte nicht abgerufen werden.

Hinweise

Nachfolgende Aufrufe mit derselben Schnittstelle, dargestellt durch den Punk-Parameter , werden als Anforderungen zum Aktualisieren des dwMask-Parameters behandelt. Server sollten die AddRef-Methode auf der Senke als Reaktion auf eine solche Anforderung nicht aufrufen.

Server verwalten nur einen einzelnen Verbindungspunkt. Versuche, ein zweites Senkenobjekt zu informieren, schlagen fehl, bis das ursprüngliche Senkenobjekt entfernt wurde. Anwendungen sollten die ITextStoreAnchor::UnadviseSink-Methode verwenden, um die Registrierung des Senkenobjekts aufzuheben, wenn keine Benachrichtigungen erforderlich sind.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile textstor.h
DLL Msctf.dll
Verteilbare Komponente TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITextStoreAnchor

ITextStoreAnchor::UnadviseSink

TS_AS_*-Konstanten