EPOC   SDK Home Glossary Indexes Previous Next Up

CMsvEntrySelection class


Contents


CMsvEntrySelection class — Entries array

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behavior

CArrayFixBase

Abstract: implementation; non-templated base class and shared code

CArrayFix<class T>

Abstract: shared templated base class.

CArrayFixFlat<TMsvId>

An array of TMsvId objects using a flat array buffer.

Defined in

msvapi.h

Link against

ment.lib

Description

This class 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 classes provide methods to access, sort, and manipulate members of the array.


Functions


CMsvEntrySelection() — Constructor

CMsvEntrySelection();

Description

The constructor simply creates an empty array.


CopyL() — Copy

CMsvEntrySelection* CopyL() const;

Description

Use this function to create 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 considerations

KErrNoMemory

A memory allocation failed.


CopyLC() — Copy and leave on cleanup stack

CMsvEntrySelection* CopyLC() const;

Description

Use this function to create 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 considerations

KErrNoMemory

A memory allocation failed.


Find() — Find ID

TInt Find(TMsvId aId) const;

Description

Use this function to find an item in the array by its entry ID.

Arguments

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.

EPOC       SDK Home Glossary Indexes Previous Next Up