Class CParserPropertyValueDaylight

CParserPropertyValueDaylight

Support

Supported from 5.0

Description

A property value which contains the daylight savings rule for a vCalendar.

The property value is stored using an instance of the CVersitDaylight class, which defines the specification for daylight saving.

To find out the property value type, use Uid() defined in the base class CParserPropertyValue. A daylight saving property UID has the value KVersitPropertyDaylightUid.

Derivation

CBase Base class for all classes to be instantiated on the heap CParserPropertyValue Abstract base class for all property values CParserPropertyValueDaylight A property value which contains the daylight savings rule for a vCalendar CParserTimePropertyValue Abstract base class for all of the date/time property value classes (CParserPropertyValueAlarm, CParserPropertyValueDate, CParserPropertyValueDateTime, CParserPropertyValueMultiDateTime, CParserPropertyValueDaylight, CParserPropertyValueRecurrence)

Defined in CParserPropertyValueDaylight:
CParserPropertyValueDaylight(), ConvertAllDateTimesToUTCL(), ConvertAllUTCDateTimesToMachineLocalL(), Value(), ~CParserPropertyValueDaylight()

Inherited from CBase:
operator new()

Inherited from CParserPropertyValue:
EncodeL(), ExternalizeL(), IsAsciiCharacterSetSufficient(), Uid()

Inherited from CParserTimePropertyValue:
SupportsInterface()

CParserPropertyValueDaylight(CVersitDaylight* aValue);

Description

Constructs a new CParserPropertyValueDaylight with a CVersitDaylight pointer. Sets the property value’s UID to KVersitPropertyDaylightUid.

Parameters

CVersitDaylight* aValue Pointer to the daylight saving specification. The property value takes ownership of the pointer.

~CParserPropertyValueDaylight();

Description

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

void ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds& aIncrement,const CVersitDaylight* aDaylight);

Description

Converts the start and end times for the daylight saving period into universal time. This will only occur if daylight saving is in effect, and the start and end times for the daylight saving period are not currently stored in universal time.

The function adds the number of seconds specified in aIncrement, then modifies the resulting date/time value by the daylight saving offset specified in aDaylight, if applicable.

Parameters

const TTimeIntervalSeconds& aIncrement A time interval in seconds which represents the negative of the time zone of the originating machine. For instance, if the time zone is +04:30, aIncrement should be set to – 04:30. const CVersitDaylight* aDaylight The specification for daylight saving. If a date/time value is within the period for daylight saving, the date/time is modified by the daylight saving offset.

void ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds& aIncrement);

Description

Converts the start and end times for the daylight saving period from universal time into local time for the target machine. This will only occur if daylight saving is in effect, and the start and end times for the daylight saving period are stored in universal time.

From v6.1, this function is deprecated.

Parameters

const TTimeIntervalSeconds& aIncrement A time interval in seconds to add to the start and end date/times for daylight saving. This should normally be the universal time offset for the machine's locale.

CVersitDaylight* Value() const;

Description

Gets the daylight saving property value.

Return value

CVersitDaylight* Pointer to the daylight saving specification.