|
IAdviseSink
The IAdviseSink interface enables containers and other interested objects to receive
notifications of data changes, view changes, and compound-document changes occurring in
objects of interest. Container applications, for example, require such
notifications to keep cached presentations of their linked and embedded objects
up-to-date.
For an advisory connection to exist, the object that is to receive
notifications must implement IAdviseSink, and the objects in which it is interested must implement one or more of the
following: IOleObject::Advise, IDataObject::DAdvise, or IViewObject::SetAdvise. Objects implementing IOleObject must support all of these methods.
As shown in the following table, an object that has implemented an advise sink
registers its interest in receiving certain types of notifications by calling
the appropriate method:
Call This Method
| To Register for These Notifications
| IOleObject::Advise
| When a document is saved, closed, or renamed.
| IDataObject::DAdvise
| When a document's data changes.
| IViewObject::SetAdvise
| When a document's presentation changes.
|
When an event occurs that applies to a registered notification type, the
object application calls the appropriate IAdviseSink method. For example, when an embedded object closes, it calls the IAdviseSink::OnClose method to notify its container. These notifications are asynchronous,
occurring after the events that trigger them
When to Implement
Objects, such as container applications, compound documents, and client sites
implement IAdviseSink to receive notification of changes in data, presentation, name, or state of
their linked and embedded objects. Implementors register for one or more types
of notification, depending on their needs.
Notifications for an embedded object originate in the object application and
flow to the container by way of the object handler. If the object is a linked
object, the OLE link object intercepts the notifications from the object handler
and notifies the container directly. All containers, the object handler, and
the OLE link object register for OLE notifications. The typical container also
registers for view notifications. Data notifications are usually sent to the OLE
link object and object handler.
When to Use
Objects call IAdviseSink to notify other objects with whom they have an advisory connection of changes
in data, view, name, or state.
Note Making synchronous calls within asynchronous methods is not valid, so you
cannot make synchronous calls within any of the the IAdviseSink interface's methods. For example, an implementation of IAdviseSink::OnDataChange cannot contain a call to IDataObject::GetData.
Methods in Vtable Order
IUnknown Methods
| Description
| QueryInterface
| Returns pointers to supported interfaces.
| AddRef
| Increments reference count.
| Release
| Decrements reference count.
|
IAdviseSink Methods
| Description
| OnDataChange
| Advises that data has changed.
| OnViewChange
| Advises that view of object has changed.
| OnRename
| Advises that name of object has changed.
| OnSave
| Advises that object has been saved to disk.
| OnClose
| Advises that object has been closed.
|
See Also
IAdviseSink2, IDataAdviseHolder, IOleAdviseHolder, IOleObject::Advise, IOleObject::Unadvise, IOleObject::EnumAdvise
Related LinksSoftware for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET More Online Helps Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages
|
