IUpdateLink Class Reference

#include <IUpdateLink.h>

Inheritance diagram for IUpdateLink:

Public Types
enum	{ kDefaultIID = IID_IUPDATELINK }
enum	{ kSuccess = 0, kOutOfMemory = kOutOfMemoryError, kInvalidParameter = kInvalidParameterErr, kNoAssociatedPageItem = kNoAssociatedPageItemError }

Public Member Functions
virtual ErrorCode	DoUpdateLink (const ClassID &providerId, ILink *iLink, UID &objectUID, UIFlags uiFlags=kSuppressUI)=0
virtual bool	IsOPIorDCS (ILink *iLink)=0
virtual ErrorCode	UpdateOPIandDCS (ILink *iLink)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

You use this interface to update a page item to the lastest linked information.

See Also

ILink

Member Enumeration Documentation

anonymous enum

DoUpdateLink return values

Enumerator
kSuccess	No error
kOutOfMemory	Out of memory
kInvalidParameter	Invalid parameter
kNoAssociatedPageItem	The data link does not have an associated page item

Member Function Documentation

virtual ErrorCode IUpdateLink::DoUpdateLink ( const ClassID &  providerId, ILink *  iLink, UID &  objectUID, UIFlags  uiFlags = kSuppressUI  )

pure virtual

Update the link by reimporting the data. \ The update uses the setting last used to import the data. If this fails because the data is no longer appropriate for this import filter, the import uses the standard import code which picks a new filter. \ A new page item wil be created to replace the original item.

Parameters

providerId	[IN[ Id of the update link service provider to use to update.
iLink	[IN[ Link to be updated.
objectUID	[OUT] UID of the new link object and page item.
uiFlags	[IN] Denotes whether to allow UI during the update operation.

Returns

kSuccess if the update succeeds, else an error code.

virtual bool IUpdateLink::IsOPIorDCS ( ILink *  iLink )

pure virtual

Determines if the link is an OPI or DCS link.

Parameters

iLink

[IN] Link to be checked.

Returns

True if the link is an OPI or DCS link, else false.

virtual ErrorCode IUpdateLink::UpdateOPIandDCS ( ILink *  iLink )

pure virtual

Updates an OPI or DCS link.

Parameters

iLink

[IN] Link to be updated.

Precondition

The link must be an OPI or DCS link.

Returns

kSuccess if the update succeeds, else an error code.