Class TAgnException

TAgnException

Support

Supported from 5.0

Description

Stores the date of an exception to a repeating entry.

Agenda entries own a repeat definition (CAgnRptDef*) which contains the repeat details for the entry, including exceptions. This pointer is NULL if the entry is not repeating. To set it, use CAgnEntry::SetRptDefL(). The repeat definition can be retrieved using CAgnBasicEntry::RptDef(). Exceptions can be added, removed, pruned and searched for using functions defined in class CAgnBasicEntry, or the CAgnRptDef class can be used directly.

Defined in TAgnException:
Date(), ExternalizeL(), InternalizeL(), SetDate(), TAgnException()

TAgnException();
TAgnException(TAgnDate aDate);

Description

Overloaded C++ constructor. The exception can be constructed:

• by default — this initialises the exception date to NULL

• with an exception date

void SetDate(TAgnDate aDate);

Description

Sets the exception date, specified as an agenda date value.

Parameters

TAgnDate aDate The exception date.

TAgnDate Date() const;

Description

Gets the exception date.

Return value

TAgnDate The exception date.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises an exception date to a write stream. The presence of this function means that the standard templated operator<<() is available to externalise objects of this class

Parameters

RWriteStream& aStream Stream to which the object should be externalised.

void InternalizeL(RReadStream& aStream);

Description

Internalises an exception date from a read stream. The presence of this function means that the standard templated operator>>() is available to internalise objects of this class.

Parameters

RReadStream& aStream Stream from which the object should be internalised.