PstLstUtils Class Reference

#include <PstLstUtils.h>

Static Public Member Functions
static ErrorCode	DoCreateNewData (const UIDList &pageItemListToAddTo, const WideString &name, UIDList &newItemsList)
static ErrorCode	DoGetName (const UIDRef &pstLstItemRef, WideString &name)
static ErrorCode	DoSetName (UIDList &pstLstDataList, const WideString &name)
static bool16	AllPstLstAreEmpty (const UIDList &itemList)
static void	RemoveNonPstLstItems (UIDList &pageItemList)

Detailed Description

Implements some model-specific helper methods shared by different source files in this plug-in.

Member Function Documentation

bool16 PstLstUtils::AllPstLstAreEmpty ( const UIDList &  itemList )

static

Tests whether all items in the itemList are devoid of persistent list items.

Parameters

itemList

IN List of page items to examine. These page items must aggregate IPstLstUIDList.

Returns

kTrue of all items are devoid of persistent list items, kFalse if one or more items have one or more persistent list item.

ErrorCode PstLstUtils::DoCreateNewData ( const UIDList &  pageItemListToAddTo, const WideString &  name, UIDList &  newItemsList  )

static

Creates new persistent list item data on a page item.

Parameters

pageItemListToAddTo	IN List of page items (which aggregate IPstLstUIDList) to which you want to add new persistent list items.
name	IN The name of the persistent list item to add to each item in pageItemListToAddTo.
newItemsList	OUT The newly created persistent list items.

Returns

kSuccess if success, non-zero otherwise.

ErrorCode PstLstUtils::DoGetName ( const UIDRef &  pstLstItemRef, WideString &  name  )

static

Gets the name of the persistent list item.

Parameters

pstLstItemRef	IN The persistent list item to examine (not page item).
name	OUT The name in the persistent list item.

Returns

kSuccess if success, non-zero otherwise.

ErrorCode PstLstUtils::DoSetName ( UIDList &  pstLstDataList, const WideString &  name  )

static

Sets the name of the persistent list item.

Parameters

pstLstDataList	IN The list of persistent list items to modify (not page item).
name	IN The new name in the persistent list item.

Returns

kSuccess if success, non-zero otherwise.

void PstLstUtils::RemoveNonPstLstItems ( UIDList &  pageItemList )

static

Removes page items that do not have any persistent list items.

Parameters

pageItemList

IN/OUT A list of page items to examine. This list is modified and returned to the caller via this parameter.