IOleLink::UnbindSource method

Breaks the connection between a linked object and its link source.

Syntax

HRESULT UnbindSource(

);

Parameters

This method has no parameters.

Return Value

This method returns S_OK on success.

Remarks

You typically do not call UnbindSource directly. When it's necessary to deactivate the connection to the link source, your container typically calls IOleObject::Close or IUnknown::Release; the linked object's implementation of these methods calls UnbindSource. The linked object's IAdviseSink::OnClose implementation also calls UnbindSource.

Notes to Implementers

The linked object's implementation of UnbindSource does nothing if the link source is not currently bound. If the link source is bound, UnbindSource calls the link source's IOleObject::Unadvise and IDataObject::DUnadvise implementations to delete the advisory connections to the link source. The UnbindSource method also calls the compound document's IOleContainer::LockContainer implementation to unlock the containing compound document. This undoes the lock on the container and the advisory connections that were established in IOleLink::BindToSource. UnbindSource releases all the linked object's interface pointers to the link source.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header oleidl.h

See Also

IAdviseSink::OnClose

IDataObject::DUnadvise

IOleLink

IOleLink::BindToSource

IOleObject::Close

IOleObject::Unadvise