CVersitRecurrenceYearlyByMonth Class Reference

#include <app/vrecur.h>

Link against: vcal.lib

class CVersitRecurrenceYearlyByMonth : public CVersitRecurrence

Inherits from

CVersitRecurrenceYearlyByMonth
- CVersitRecurrence

Public Attributes
CArrayFix< TMonth > *	iArrayOfMonthsInYearOccurrences

Public Member Functions
	CVersitRecurrenceYearlyByMonth(TInt, TInt, TVersitDateTime , CArrayFix< TMonth > )
	~CVersitRecurrenceYearlyByMonth()
virtual IMPORT_C void	ExternalizeOccurrenceListsL(RWriteStream &)

Inherited Attributes
	CVersitRecurrence::iDuration
	CVersitRecurrence::iEndDate
	CVersitRecurrence::iInterval
	CVersitRecurrence::iRepeatType

Inherited Enumerations
	CVersitRecurrence:TType

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CVersitRecurrence::CVersitRecurrence(TInt,TInt,TVersitDateTime *)
	CVersitRecurrence::~CVersitRecurrence()

Detailed Description

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.

Member Attribute Documentation

iArrayOfMonthsInYearOccurrences

CArrayFix< TMonth > *

iArrayOfMonthsInYearOccurrences

Pointer to an array of month values.

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.

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