Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

IOleObject::Advise method

Establishes an advisory connection between a compound document object and the calling object's advise sink, through which the calling object receives notification when the compound document object is renamed, saved, or closed.

Syntax


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

Parameters

pAdvSink [in]

Pointer to the IAdviseSink interface on the advise sink of the calling object.

pdwConnection [out]

Pointer to a token that can be passed to IOleObject::Unadvise to delete the advisory connection.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return codeDescription
E_OUTOFMEMORY

Insufficient memory available for this operation.

 

Remarks

The IOleObject::Advise method sets up an advisory connection between an object and its container, through which the object informs the container's advise sink of close, save, rename, and link-source change events in the object. A container calls this method, normally as part of initializing an object, to register its advisory sink with the object. In return, the object sends the container compound-document notifications by calling IAdviseSink or IAdviseSink2.

If container and object successfully establish an advisory connection, the object receiving the call returns a nonzero value through pdwConnection to the container. If the attempt to establish an advisory connection fails, the object returns zero. To delete an advisory connection, the container calls IOleObject::Unadvise and passes this nonzero token back to the object.

An object can delegate the job of managing and tracking advisory events to an OLE advise holder, to which you obtain a pointer by calling CreateOleAdviseHolder. The returned IOleAdviseHolder interface has three methods for sending advisory notifications, as well as IOleAdviseHolder::Advise, IOleAdviseHolder::Unadvise, and IOleAdviseHolder::EnumAdvise methods that are identical to those for IOleObject. Calls to IOleObject::Advise, IOleObject::Unadvise, or IOleObject::EnumAdvise are delegated to corresponding methods in the advise holder.

To destroy the advise holder, simply call IUnknown::Release on the IOleAdviseHolder interface.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleIdl.h

IDL

OleIdl.Idl

IID

IID_IOleObject is defined as 00000112-0000-0000-C000-000000000046

See also

CreateOleAdviseHolder
IOleObject
IOleObject::Unadvise
IOleObject::EnumAdvise
IOleAdviseHolder::Advise

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.