IOleObject::Advise-Methode (oleidl.h)

  • Artikel

Stellt eine Empfehlungsverbindung zwischen einem zusammengesetzten Dokumentobjekt und der Empfehlungssenke des aufrufenden Objekts her, über die das aufrufende Objekt eine Benachrichtigung empfängt, wenn das Objekt des zusammengesetzten Dokuments umbenannt, gespeichert oder geschlossen wird.

Syntax

HRESULT Advise(
  [in]  IAdviseSink *pAdvSink,
  [out] DWORD       *pdwConnection
);

Parameter

[in] pAdvSink

Zeiger auf die IAdviseSink-Schnittstelle auf der Empfehlungssenke des aufrufenden Objekts.

[out] pdwConnection

Zeiger auf ein Token, das an IOleObject::Unadvise übergeben werden kann, um die Empfehlungsverbindung zu löschen.

Rückgabewert

Diese Methode gibt S_OK bei Erfolg zurück. Weitere mögliche Rückgabewerte:

Rückgabecode Beschreibung
E_OUTOFMEMORY
 Für diesen Vorgang ist nicht genügend Arbeitsspeicher verfügbar.

Hinweise

Die IOleObject::Advise-Methode richtet eine Empfehlungsverbindung zwischen einem Objekt und seinem Container ein, über die das Objekt die Empfehlungssenke des Containers über Schließen-, Speichern-, Umbenennens- und Linkquellenänderungsereignisse im Objekt informiert. Ein Container ruft diese Methode normalerweise im Rahmen der Initialisierung eines Objekts auf, um seine Advisory-Senke beim -Objekt zu registrieren. Im Gegenzug sendet das Objekt die Containerverbunddokumentbenachrichtigungen, indem es IAdviseSink oder IAdviseSink2 aufruft.

Wenn Container und Objekt erfolgreich eine Empfehlungsverbindung herstellen, gibt das Objekt, das den Aufruf empfängt, einen Nonzero-Wert über pdwConnection an den Container zurück. Wenn der Versuch, eine Empfehlungsverbindung herzustellen, fehlschlägt, gibt das Objekt null zurück. Um eine Empfehlungsverbindung zu löschen, ruft der Container IOleObject::Unadvise auf und übergibt dieses Nonzero-Token zurück an das -Objekt.

Ein -Objekt kann die Aufgabe des Verwaltens und Nachverfolgens von Beratungsereignissen an einen OLE-Ratgeber delegieren, auf den Sie einen Zeiger erhalten, indem Sie CreateOleAdviseHolder aufrufen. Die zurückgegebene IOleAdviseHolder-Schnittstelle verfügt über drei Methoden zum Senden von Empfehlungsbenachrichtigungen sowie über die Methoden IOleAdviseHolder::Advise, IOleAdviseHolder::Unadvise und IOleAdviseHolder::EnumAdvise , die mit denen für IOleObject identisch sind. Aufrufe von IOleObject::Advise, IOleObject::Unadvise oder IOleObject::EnumAdvise werden an entsprechende Methoden im Berater delegiert.

Um den Berater zu zerstören, rufen Sie einfach IUnknown::Release auf der IOleAdviseHolder-Schnittstelle auf.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile oleidl.h

Weitere Informationen

CreateOleAdviseHolder

IOleAdviseHolder::Advise

IOleObject

IOleObject::EnumAdvise

IOleObject::Unadvise