Inheritance diagram for IArticleList:

Public Types
enum	{ kDefaultIID = IID_IARTICLELIST }

Public Member Functions
virtual void	AddArticle (UID articleUID, int32 pos=-1)=0

virtual void	RemoveArticle (UID articleUID)=0

virtual void	RemoveNthArticle (int32 pos)=0

virtual void	RemoveAllArticles ()=0

virtual int32	CountArticles () const =0

virtual UID	GetNthArticleUID (int32 pos) const =0

virtual int32	GetArticlePosition (UID articleUID) 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

Provides access to the Articles inside a document

Member Function Documentation

virtual void IArticleList::AddArticle	(	UID	articleUID,
		int32	pos = `-1`
	)

pure virtual

Add an Article at the specified position in the document's Article List.

Parameters

articleUID	IN the UID of the Article that needs to be added.
pos	IN 0 based position at which to add the Article. Specify -1 to add to the end.

virtual int32 IArticleList::CountArticles ( ) const

pure virtual

Get the number of Articles in the document's Article List.

virtual int32 IArticleList::GetArticlePosition ( UID articleUID ) const

pure virtual

Get the position of the Article in the document's Article List.

Parameters

articleUID IN the UID of the Article in the document's Article List.

virtual UID IArticleList::GetNthArticleUID ( int32 pos ) const

pure virtual

Get the Nth Article UID from the document's Article List.

Parameters

pos	IN the 0 based index of the Article in the document's Article List.

virtual void IArticleList::RemoveAllArticles ( )

pure virtual

Remove all Articles from the document's Article List.

virtual void IArticleList::RemoveArticle ( UID articleUID )

pure virtual

Remove an Article from the document's Article List.

Parameters

articleUID IN the UID of the Article that needs to be removed.

virtual void IArticleList::RemoveNthArticle ( int32 pos )

pure virtual

Remove an Article from the document's Article List.

Parameters

pos	IN the position of the Article in the document's Article List.