IOleUILinkContainer::CancelLink

Disconnects the selected links.

HRESULT CancelLink(
  DWORD dwLink  //Unique 32-bit link identifier
);

Parameter

dwLink: [in] Container-defined unique 32-bit identifier for a single link. Containers can use the pointer to the link's container site for this value.

Return Values

This method supports the standard return values E_FAIL,

E_INVALIDARG, and E_OUTOFMEMORY, as well as the following:

S_OK: Successfully disconnected the selected links.
E_ACCESSDENIED: Insufficient access permissions.

Remarks

Notes To Callers

Call CancelLink when the user selects the Break Link button from the Links dialog box. The link should be converted to a picture. The Links dialog box will not be dismissed for OLE links.

Notes To Implementers

For OLE links, OleCreateStaticFromData can be used to create a static picture object using the IDataObject interface of the link as the source.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in oledlg.h.