IDataLinkListReference Class Reference

#include <IDataLinkListReference.h>

Inheritance diagram for IDataLinkListReference:

Public Member Functions
virtual void	SetList (const UIDList &list)=0
virtual const UIDList &	GetList ()=0
virtual void	ReadWrite (IPMStream *iPMStream, ImplementationID id)=0
virtual int32	AddUID (UID uid)=0
virtual int32	RemoveUID (UID uid)=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

IDataLinkListReference stores references to multiple data links.

Member Function Documentation

virtual int32 IDataLinkListReference::AddUID ( UID  uid )

pure virtual

Method to add a data link UID to the list.

Parameters

uid	to add to the list. Only valid UIDs and non-duplicates are added.

Returns

0 when the method succeeds and non-zero otherwise.

virtual const UIDList& IDataLinkListReference::GetList ( )

pure virtual

Method to get a list of UIDs to data links (IDataLink).

Returns

a list of UIDs of data links.

virtual void IDataLinkListReference::ReadWrite ( IPMStream *  iPMStream, ImplementationID  id  )

pure virtual

Method to persist the list of data links.

Parameters

iPMStream	is the stream to read or write from.
id	is the implementation ID.

virtual int32 IDataLinkListReference::RemoveUID ( UID  uid )

pure virtual

Method to remove a data link UID from the list.

Parameters

uid	to remove from the list.

Returns

0 when the method succeeds and non-zero otherwise.

virtual void IDataLinkListReference::SetList ( const UIDList &  list )

pure virtual

Method to set a list of UIDs to data links (IDataLink).

Parameters

list	of UIDs of data links.