IOleAdviseHolder::Advise

Establishes an advisory connection between an OLE object and the calling object's advise sink. Through that sink, the calling object can receive notification when the OLE object is renamed, saved, or closed.

HRESULT Advise(

IAdviseSink * pAdvise,	//Pointer to advise sink
DWORD * pdwConnection	//Pointer to a token
);

Parameters

pAdvise

[in] Points to the advisory sink that should be informed of changes.

pdwConnection

[out] Points to a token that can be passed to the IOleAdviseHolder::Unadvise method to delete the advisory connection. The calling object is responsible for calling both IUnknown::AddRef and IUnknown::Release on this pointer.

Return Values

S_OK

Advisory connections set up successfully.

E_INVALIDARG

pAdvise is NULL.

Comments

Containers, object handlers, and link objects all create advise sinks to receive compound-document notifications (OnSave, OnRename, and OnClose) for objects of interest. They also call IOleObject::Advise to establish advisory connections with those objects. Objects whose implementations of IOleObject::Advise include a call to CreateOleAdviseHolder delegate these calls to IOleAdviseHolder::Advise.

If the attempt to establish an advisory connection is successful, the object receiving the call returns a nonzero value through pdwConnection. If the attempt fails, the object returns a zero. To delete an advisory connection, the object with the advise sink passes this nonzero token back to the object by calling IOleAdviseHolder::Unadvise.

See Also

IOleAdviseHolder::UnAdvise, IOleAdviseHolder::EnumAdvise, IOleObject::Advise

Software for developers

Delphi Components
.Net Components
Software for Android Developers

More information resources

MegaDetailed.Net
Unix Manual Pages
Delphi Examples

Databases for Amazon shops developers

Amazon Categories Database
Browse Nodes Database