Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

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

 » Symbian OS v6.1 Edition for C++ » API Reference » Agenda File » TAgnEntryIter

Location: agmmiter.h
Link against: agnmodel.lib

Class TAgnEntryIter

TAgnEntryIter

Support

Supported from 5.0

Description

Iterates over the entries in an agenda file. This class should not be used if the agenda model is in client mode: use the RAgendaServ entry iteration functions instead.

Defined in TAgnEntryIter:
At(), NextL(), SetToFirstL(), TAgnEntryIter()

Construction

TAgnEntryIter()

TAgnEntryIter(const CAgnEntryModel* aModel);

Description

The C++ constructor constructs the iterator with a pointer to an agenda model.

Parameters

const CAgnEntryModel* aModel

The agenda model over which the iterator will iterate.

[Top]

Iterator position

SetToFirstL()

TBool SetToFirstL();

Description

Resets the iterator to the first entry in the file.

Return value

TBool

ETrue if there is at least one entry and its ID can be extracted (using At()). Otherwise EFalse.

NextL()

TBool NextL();

Description

Moves the iterator to the next entry.

Return value

TBool

ETrue if there is at least one more entry. EFalse if not.

[Top]

Get ID

At()

TAgnEntryId At();    

Description

Gets the ID of the entry at the current iterator position.

Return value

TAgnEntryId

The ID of the entry at the current iterator position.

Copyright ©2002  Symbian Ltd.       6.1-00174

[Top]