CVersitRecurrenceYearlyByMonth Class Reference

class CVersitRecurrenceYearlyByMonth : public CVersitRecurrence

Defines a list of months when a 'yearly by month' recurrence is to repeat.

Used by a repeating event (a vCalendar event or to-do) to define the months in which it is to occur. The months on which the event occurs are identified by their number in the year (between 1 and 12 inclusive).

A pointer to this object may be owned by a CParserPropertyValueRecurrence object.

Inherits from

Constructor & Destructor Documentation

CVersitRecurrenceYearlyByMonth(TInt, TInt, TVersitDateTime *, CArrayFix< TMonth > *)

IMPORT_C CVersitRecurrenceYearlyByMonth ( TInt aInterval,
TInt aDuration,
TVersitDateTime * aEndDate,
CArrayFix < TMonth > * aArrayOfMonthsInYearOccurrences

Constructs the CVersitRecurrenceYearlyByMonth object.

Sets the repeat type to CVersitRecurrence::EYearlyByMonth .

If a duration and an end date are both specified, the end date takes precedence.


TInt aInterval The number of years between repeats.
TInt aDuration The duration, in years, for which the event should recur. A value of zero indicates the repeat should continue forever.
TVersitDateTime * aEndDate Optional pointer to the end date for the repeat event. The object takes ownership of this pointer.
CArrayFix < TMonth > * aArrayOfMonthsInYearOccurrences Pointer to an array of month values. The object takes ownership of this pointer.


IMPORT_C ~CVersitRecurrenceYearlyByMonth ( )

Frees all resources owned by the object, prior to its destruction.

Member Functions Documentation

ExternalizeOccurrenceListsL(RWriteStream &)

IMPORT_C void ExternalizeOccurrenceListsL ( RWriteStream & aStream ) const [virtual]

Writes the months of the year, as month numbers, in which the event occurs to the output stream.

For example, if the event occurs from September to December inclusive, the string written to aStream would be "9 10 11 12 ".


RWriteStream & aStream The stream to which the occurrence list is to be written.

Member Data Documentation

CArrayFix< TMonth > * iArrayOfMonthsInYearOccurrences

CArrayFix < TMonth > * iArrayOfMonthsInYearOccurrences

Pointer to an array of month values.