CVersitRecurrenceYearlyByDay Class Reference

#include <app/vrecur.h>

Link against: vcal.lib

class CVersitRecurrenceYearlyByDay : public CVersitRecurrence

Inherits from

CVersitRecurrenceYearlyByDay
- CVersitRecurrence

Public Attributes
CArrayFix< TInt > *	iArrayOfDaysInYearOccurrences

Public Member Functions
	CVersitRecurrenceYearlyByDay(TInt, TInt, TVersitDateTime , CArrayFix< TInt > )
	~CVersitRecurrenceYearlyByDay()
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 days when a 'yearly by day' recurrence is to be repeated.

Used by a repeating event (a vCalendar event or to-do) to define when it is to occur.

The days on which the repeat occurs are identified by their day number in the year (between 1 and 366 inclusive).

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

Member Attribute Documentation

iArrayOfDaysInYearOccurrences

CArrayFix< TInt > *

iArrayOfDaysInYearOccurrences

Pointer to an array of integers between 1 and 366 inclusive.

Each integer represents a day on which the repeat event occurs.

Constructor & Destructor Documentation

CVersitRecurrenceYearlyByDay ( TInt, TInt, TVersitDateTime , CArrayFix< TInt > )

IMPORT_C	CVersitRecurrenceYearlyByDay	(	TInt	aInterval,
			TInt	aDuration,
			TVersitDateTime *	aEndDate,
			CArrayFix< TInt > *	aArrayOfDaysInYearOccurrences
		)

Constructs the CVersitRecurrenceYearlyByDay object.

Sets the repeat type to EYearlyByDay.

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.
aArrayOfDaysInYearOccurrences	Pointer to an array of integers between 1 and 366 inclusive. Each integer represents a day on which the repeat event occurs. The object takes ownership of this pointer.