| class CCalInstanceIterator : public CBase |
A calendar instance iterator
This class defines an interface for iterating through calendar instances and can be created by calling the appropriate methods on CCalInstanceView. Please see the coments on those APIs for the details of which instances will be iterated though.
| Public Member Functions | |
|---|---|
| ~CCalInstanceIterator() | |
| TInt | Count() |
| TBool | HasMore() |
| CCalInstance * | NextL() |
| CCalInstance * | PreviousL() |
| Protected Member Functions | |
|---|---|
| CCalInstanceIterator(const CCalInstanceViewImpl &) | |
| Protected Attributes | |
|---|---|
| const CCalInstanceViewImpl & | iInstanceViewImpl |
| CCalSessionImpl & | iSessionImpl |
| CCalInstanceIterator | ( | const CCalInstanceViewImpl & | aInstanceViewImpl | ) | [protected] |
| const CCalInstanceViewImpl & aInstanceViewImpl |
| TInt | Count | ( | ) | const [pure virtual] |
Returns the total number of instances the iterator will iterate through, including the starting instance if one was provided.
Note that it is best to avoid using this API if possible because it will be slow to calculate the count, if the iterator contains a lot of instances.
The number of instances found or, if there was a problem calculating the count, a system-wide error code.
capability
None
| TBool | HasMore | ( | ) | const [pure virtual] |
Checks to see if there are any more results in the iterator to be returned by calling NextL.
ETrue if there are more results, EFalse if not.
capability
None
| CCalInstance * | NextL | ( | ) | [pure virtual] |
Fetches the next instance in the iterator.
The next instance in the iterator or NULL if there are no more instances. This API returns ownership of the instance.
leave
KErrNotFound If there is a problem creating the instance because the entry cannot be found.
leave
KErrNotReady If the calendar file is on a drive where the media has been removed. Otherwise any of the system-wide error codes.
capability
ReadUserData
| CCalInstance * | PreviousL | ( | ) | [pure virtual] |
Fetches the previous instance in the iterator.
The previous instance in the iterator or NULL if there are no more instances. This API returns ownership of the instance.
leave
KErrNotFound If there is a problem creating the instance because the entry cannot be found.
leave
KErrNotReady If the calendar file is on a drive where the media has been removed. Otherwise any of the system-wide error codes.
capability
ReadUserData