Class CCalIter

class CCalIter : public CBase;

Description

An iterator for iterating though all the entries in the calendar store.

This may be used by a synchronisation application to iterate all entries in the file to find entries that have been added\deleted between two synchronisations.

The application must not create the entry view or instance view while iterating through the entries.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CCalIter - An iterator for iterating though all the entries in the calendar store

Members

Defined in CCalIter:
FirstL(), NewL(), NextL(), ~CCalIter()

Inherited from CBase:
Delete(), Extension_(), operator new()

Capability:

Illegal

static IMPORT_C CCalIter *NewL(CCalSession &aSession);

Description

Allocates and constructs an iterator for iterating though all the entries in the file.

Parameters

CCalSession &aSession The session to the calendar file.

Return value

CCalIter * CCalIter pointer

Capability:

Illegal

IMPORT_C ~CCalIter();

Description

The destructor frees all resources owned by the iterator, prior to its destruction.

Capability:

Illegal

IMPORT_C const TDesC8 &FirstL();

Description

Sets the iterator to the first entry which is a parent (parent and its children have the same Uid) and retrieves its Uid.

Return value

const TDesC8 & a descriptor which contains the Uid of the first entry. The return value can be KNullDesC8 if there is no entry in the file.

Capability:

Illegal

IMPORT_C const TDesC8 &NextL();

Description

Moves the entry iterator to the next entry which is a parent (parent and its children have the same Uid) and retrieves its Uid.

Return value

const TDesC8 & a descriptor which contains the Uid of the first entry. The return value can be KNullDesC8 if there is no entry in the file.