Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: msvstd.h
Link against: msgs.lib

Class CMsvEntrySelection

CMsvEntrySelection

Support

Supported from 5.0

Description

Encapsulates an array of entry IDs.

An object of this type is commonly passed to a function to indicate the set of entries on which the function should operate. The array base class (CArrayFixFlat<TMsvId>) provide methods to access, sort, and manipulate members of the array.

In pre-Unicode versions this class had the import library ment.lib.

Derivation

CArrayFixA thin templated base class for arrays of fixed length objects
CArrayFixBaseBase class for arrays of fixed length objects
CArrayFixFlatArray of fixed length objects contained within a flat dynamic buffer
CBaseBase class for all classes to be instantiated on the heap
CMsvEntrySelectionEncapsulates an array of entry IDs

Defined in CMsvEntrySelection:
CMsvEntrySelection(), CopyL(), CopyLC(), Find()

Inherited from CArrayFix:
AppendL(), AppendL()Append, Array(), At(), Back(), End(), ExpandL(), ExtendL(), FindIsq(), InsertIsqAllowDuplicatesL(), InsertIsqL(), InsertL(), ResizeL(), operator[]

Inherited from CArrayFixBase:
Compress(), Count(), Delete(), Length(), Reset(), Sort()

Inherited from CArrayFixFlat:
SetReserveL()

Inherited from CBase:
operator new()


Functions


CMsvEntrySelection()

CMsvEntrySelection();

Description

Creates an empty array.


CopyL()

CMsvEntrySelection* CopyL() const;

Description

Creates a new CMsvEntrySelection object with the same contents as the current object. The client should delete the object when it is no longer required.

Return value

CMsvEntrySelection*

New CMsvEntrySelection with same selection as current object

Leave codes

KErrNoMemory

A memory allocation failed.


CopyLC()

CMsvEntrySelection* CopyLC() const;

Description

Creates a new CMsvEntrySelection object with the same contents as the current object. The client should delete the object when it is no longer required.

The function leaves the new object on the cleanup stack.

Return value

CMsvEntrySelection*

New CMsvEntrySelection with same selection as current object

Leave codes

KErrNoMemory

A memory allocation failed.


Find()

TInt Find(TMsvId aId) const;

Description

Finds an item in the array by its entry ID.

Parameters

TMsvId aId

ID to find

Return value

TInt

The index of the position of the entry in the array, or KErrNotFound if the selection does not contain the ID.