Collapse all Symbian^3 Application Developer Library

CIMPSSAPSettingsList Class Reference

class CIMPSSAPSettingsList : public CArrayPtrSeg< CIMPSSAPSettingsListItem >

List of CIMPSSAPSettingsListItem's. List owns its list items.

CIMPSSAPSettingsList has all CArrayPtrSeg's functionality and also couple useful shortcuts to list items data. CIMPSSAPSettingsList also implements MDesCArray interface and on MdcaPoint() method, it returns SAP's name.

WVSAPSettingsStore.dll

Since: 3.0

Inherits from

CIMPSSAPSettingsList
- CArrayPtrSeg< CIMPSSAPSettingsListItem >
  - CArrayPtr
    - CArrayFix< T * >
      - CArrayFixBase
        
        CBase

Public Member Functions
	~CIMPSSAPSettingsList ()
IMPORT_C void	Delete ( TInt )
IMPORT_C void	Delete ( TInt , TInt )
IMPORT_C TInt	FindNameL (const TDesC &, TInt &)
IMPORT_C TInt	IndexForUid ( TUint32 )
IMPORT_C const CIMPSSAPSettingsListItem *	ListItemForUid ( TUint32 )
IMPORT_C TInt	MdcaCount ()
IMPORT_C TPtrC	MdcaPoint ( TInt )
IMPORT_C CIMPSSAPSettingsList *	NewL ()
IMPORT_C CIMPSSAPSettingsList *	NewLC ()
IMPORT_C TUint32	UidForIndex ( TInt )

Private Member Functions
	CIMPSSAPSettingsList ()

Inherited Functions
	CArrayFix< CIMPSSAPSettingsListItem * >::AppendL(const CIMPSSAPSettingsListItem *&)
	CArrayFix< CIMPSSAPSettingsListItem * >::AppendL(const CIMPSSAPSettingsListItem *&,TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::AppendL(const CIMPSSAPSettingsListItem **,TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::Array()const
	CArrayFix< CIMPSSAPSettingsListItem * >::At(TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::At(TInt)const
	CArrayFix< CIMPSSAPSettingsListItem * >::Back(TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::Back(TInt)const
	CArrayFix< CIMPSSAPSettingsListItem * >::CArrayFix(TBufRep,TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::End(TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::End(TInt)const
	CArrayFix< CIMPSSAPSettingsListItem * >::ExpandL(TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::ExtendL()
	CArrayFix< CIMPSSAPSettingsListItem * >::Find(const CIMPSSAPSettingsListItem *&,TKeyArrayFix &,TInt &)const
	CArrayFix< CIMPSSAPSettingsListItem * >::FindIsq(const CIMPSSAPSettingsListItem *&,TKeyArrayFix &,TInt &)const
	CArrayFix< CIMPSSAPSettingsListItem * >::InsertIsqAllowDuplicatesL(const CIMPSSAPSettingsListItem *&,TKeyArrayFix &)
	CArrayFix< CIMPSSAPSettingsListItem * >::InsertIsqL(const CIMPSSAPSettingsListItem *&,TKeyArrayFix &)
	CArrayFix< CIMPSSAPSettingsListItem * >::InsertL(TInt,const CIMPSSAPSettingsListItem *&)
	CArrayFix< CIMPSSAPSettingsListItem * >::InsertL(TInt,const CIMPSSAPSettingsListItem *&,TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::InsertL(TInt,const CIMPSSAPSettingsListItem **,TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::ResizeL(TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::ResizeL(TInt,const CIMPSSAPSettingsListItem *&)
	CArrayFix< CIMPSSAPSettingsListItem * >::operator[](TInt)
	CArrayFix< CIMPSSAPSettingsListItem * >::operator[](TInt)const
	CArrayFixBase::AtR(const CBase *,TInt)
	CArrayFixBase::CArrayFixBase(TBufRep,TInt,TInt)
	CArrayFixBase::Compress()
	CArrayFixBase::Count()const
	CArrayFixBase::CountR(const CBase *)
	CArrayFixBase::Find(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::FindIsq(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::InsertIsqAllowDuplicatesL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertIsqL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertL(TInt,const TAny *)
	CArrayFixBase::InsertL(TInt,const TAny *,TInt)
	CArrayFixBase::InsertRepL(TInt,const TAny *,TInt)
	CArrayFixBase::Length()const
	CArrayFixBase::Reset()
	CArrayFixBase::ResizeL(TInt,const TAny *)
	CArrayFixBase::SetKey(TKeyArrayFix &)const
	CArrayFixBase::SetReserveFlatL(TInt)
	CArrayFixBase::Sort(TKeyArrayFix &)
	CArrayFixBase::~CArrayFixBase()
	CArrayPtr< CIMPSSAPSettingsListItem >::CArrayPtr(TBufRep,TInt)
	CArrayPtr< CIMPSSAPSettingsListItem >::ResetAndDestroy()
	CArrayPtrSeg< CIMPSSAPSettingsListItem >::CArrayPtrSeg(TInt)
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Constructor & Destructor Documentation

CIMPSSAPSettingsList()

CIMPSSAPSettingsList

(

)

[private]

C++ default constructor.

~CIMPSSAPSettingsList()

IMPORT_C

~CIMPSSAPSettingsList

(

)

[virtual]

Destructor. Destroys list items.

Member Functions Documentation

Delete(TInt)

IMPORT_C void

Delete

(

TInt

aIndex

)

Delete elements by position.

Deletes element, frees its resource reservations and also removes element from the list.

Deleting elements from the array does not cause the array buffer to be automatically compress. Call CArrayFixBase::Compress() to return excess space to the heap.

Since: 3.0

Parameters

TInt aIndex

The element to be deleted. Indexation is relative to zero; i.e. zero implies the first element in the list. Index must not be negative and must not be greater than the number of elements currently in the array, otherwise the function raises a panic.

Delete(TInt, TInt)

IMPORT_C void	Delete	(	TInt	aIndex,
			TInt	aCount
		)

Delete elements by position.

Similar as Delete( TInt aIndex ) except deletes aCount elements instead of just one.

Since: 3.0

Parameters

TInt aIndex	The position within the array from where deletion of elements is started. Indexation is relative to zero; i.e. zero implies the first element in the list. Index must not be negative and must not be greater than the number of elements currently in the array, otherwise the function raises a panic.
TInt aCount	The number of contiguous elements to delete from the array. The value must not be negative, and index + count must not be greater than the number of elements currently in the array. Otherwise the function raises a panic.

FindNameL(const TDesC &, TInt &)

IMPORT_C TInt	FindNameL	(	const TDesC &	aName,
			TInt &	aIndex
		)	const

Finds the position of an item within the array, based on the items name. If the array has items with duplicate names, the function cannot guarantee which element, with the given name, it returns.

Since: 3.0

Parameters

const TDesC & aName

The name to find.

TInt & aIndex

If the item is found, the reference is set to the position of that element within the array. The position is relative to zero, (i.e. the first element in the array is at position 0). If the element is not found and the array is not empty, then the reference is set to the position of the first element in the array with a name which is greater than the given name. If the element is not found and the array is empty, then the reference is set to zero.

IndexForUid(TUint32)

IMPORT_C TInt

IndexForUid

(

TUint32

aUid

)

const

Returns a certain list items index in the array. Indexation is similar as in MDesCArray.

Since: 3.0

Parameters

TUint32 aUid

Uid which index to get.

ListItemForUid(TUint32)

IMPORT_C const CIMPSSAPSettingsListItem *

ListItemForUid

(

TUint32

aUid

)

const

Gets pointer to the list item having a specified aUid.

Note!! If item having a such uid isn't found from list, returns NULL.

Since: 3.0

Parameters

TUint32 aUid

Uid of item to get.

MdcaCount()

IMPORT_C TInt

MdcaCount

(

)

const

From MDesCArray.

Returns lists element count.

Since: 3.0

MdcaPoint(TInt)

IMPORT_C TPtrC

MdcaPoint

(

TInt

aIndex

)

const

From MDesCArray.

Returns a list items name.

Since: 3.0

Parameters

TInt aIndex

NewL()

IMPORT_C CIMPSSAPSettingsList *

NewL

(

)

[static]

Two-phased constructor.

Since: 3.0

NewLC()

IMPORT_C CIMPSSAPSettingsList *

NewLC

(

)

[static]

Two-phased constructor.

Since: 3.0

UidForIndex(TInt)

IMPORT_C TUint32

UidForIndex

(

TInt

aIndex

)

const

Returns a list items uid value. Indexation is similar as in MDesCArray.

Since: 3.0

Parameters

TInt aIndex

Index which uid to get. If index is out of bounds, function raises E32USER-CBase 21 panic.