Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MSVSTD.H
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

Class CMsvEntrySelection

class CMsvEntrySelection : public CArrayFixFlat< TMsvId >;

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.

Derivation

Members

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


Construction and destruction


CMsvEntrySelection()

IMPORT_C CMsvEntrySelection();

Description

Creates an empty array.

[Top]


Member functions


CopyL()

IMPORT_C 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()

IMPORT_C 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()

IMPORT_C 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.