IUpdateLinkService Class Reference

#include <IUpdateLinkService.h>

Inheritance diagram for IUpdateLinkService:

Public Types
enum	{ kDefaultIID = IID_IUPDATELINKSERVICE }

Public Member Functions
virtual bool16	CanUpdateLink (const ILink *iLink)=0
virtual ErrorCode	DoUpdateLink (ILink *iLink, UID &objectUID, UIFlags uiFlags)=0
virtual ErrorCode	PreUpdateLink (ILink *iLink)=0
virtual ErrorCode	PostUpdateLink (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

An interface used by ILink::Update() to update a link. Must be used in conjunction with kUpdateLinkService. Clients who implement custom datalink should implement this interface.

See Also

ILink

Member Function Documentation

virtual bool16 IUpdateLinkService::CanUpdateLink ( const ILink *  iLink )

pure virtual

Returns whether the provider can update the link object.

Parameters

iLink

[IN] Link to update.

Returns

kTrue if the service provider can update the link, else kFalse.

virtual ErrorCode IUpdateLinkService::DoUpdateLink ( ILink *  iLink, UID &  objectUID, UIFlags  uiFlags  )

pure virtual

Updates the link. \ This method may delete the original link object and associated objects and creates new ones to replace them.

Parameters

iLink	[IN] Link to update.
objectUID	[OUT] UID of the new link object. \ The UID may be the same as the original one.
uiFlags	[IN] Denotes whether to use UI during the update operation.

Returns

kSuccess if the update succeeds, else an error code.

virtual ErrorCode IUpdateLinkService::PostUpdateLink ( ILink *  iLink )

pure virtual

Called after the link is updated. \ Ususally used to perform post-notification of the update.

Parameters

iLink

[IN] Link that has been update.

Returns

kSuccess if the update should proceed, else an error code. \ The update is aborted if the return value is not kSuccess.

virtual ErrorCode IUpdateLinkService::PreUpdateLink ( ILink *  iLink )

pure virtual

Called before the link is updated. \ Ususally used to perform pre-notification of the update.

Parameters

iLink

[IN] Link to update.

Returns

kSuccess if the update should proceed, else an error code. \ The update is aborted if the return value is not kSuccess.