Inheritance diagram for IXMLReferenceListData:

Public Types
enum	{ kDefaultIID = IID_IXMLREFERENCELISTDATA }

enum	_Placement { kBeginningIndex = 0, kEndIndex = -2, kInvalidIndex = -1 }

Public Member Functions
virtual void	Insert (const XMLReference &xmlRef, int32 pos=kEndIndex)=0

virtual void	Remove (const XMLReference &xmlRef)=0

virtual void	Clear (void)=0

virtual XMLReference	Get (int32 index) const =0

virtual void	Set (int32 index, const XMLReference &newXMLRef)=0

virtual int32	GetIndex (const XMLReference &xmlRef) const =0

virtual int32	Size (void) const =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

Data interface for passing a list of XMLReference; from client code, use IXMLElementCommands methods rather than process low-level commands directly.

Member Enumeration Documentation

Enumeration giving positions in list for inserts

virtual void IXMLReferenceListData::Clear ( void )

pure virtual

Empty list contents

virtual XMLReference IXMLReferenceListData::Get ( int32 index ) const

pure virtual

Parameters

index specifies index of element of interest

virtual int32 IXMLReferenceListData::GetIndex ( const XMLReference & xmlRef ) const

pure virtual

Return index given an XMLReference

Parameters

xmlRef specifies the XMLReference of interest

virtual void IXMLReferenceListData::Insert	(	const XMLReference &	xmlRef,
		int32	pos = `kEndIndex`
	)

pure virtual

Add new XMLReference by default at end of list

Parameters

xmlRef	specifies object to add
pos	location to add at (one of _Placement values)

virtual void IXMLReferenceListData::Remove ( const XMLReference & xmlRef )

pure virtual

Remove supplied XMLReference from list

Parameters

xmlRef specifies object to remove

virtual void IXMLReferenceListData::Set	(	int32	index,
		const XMLReference &	newXMLRef
	)

pure virtual

Mutate item at specified index to be supplied XMLReference

Parameters

index	location of the element
newXMLRef	element to put in this new location

virtual int32 IXMLReferenceListData::Size ( void ) const

pure virtual

Count of XMLReference's stored on this interface