Class CParserPropertyValueMultiDateTime

CParserPropertyValueMultiDateTime

Support

Supported from 5.0

Description

A property value which consists of a list of date/time values. This can be externalised and converted between local time and universal time. To find out the property value type, use Uid() defined in the base class CParserPropertyValue. A multiple date/time property value UID has the value KVersitPropertyMultiDateTimeUid.

The class defines an ExternalizeL() function which has not been documented. It is invoked by the parser's ExternalizeL() function.

Derivation

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

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

Inherited from CBase:
operator new()

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

Inherited from CParserTimePropertyValue:
SupportsInterface()

CParserPropertyValueMultiDateTime(CArrayPtr<TVersitDateTime>* aValue);

Description

Constructs a CParserPropertyValueMultiDateTime with an array of TVersitDateTimes. Sets the property value’s UID to KVersitPropertyMultiDateTimeUid.

Parameters

CArrayPtr<TVersitDateTime>* aValue Pointer to an array of TVersitDateTime objects, each of which specifies a date/time value, and information about the value, for instance whether the date/time is specified in universal time, or in the machine's local time. The CParserPropertyValueMultiDateTime object takes ownership of the array.

~CParserPropertyValueMultiDateTime();

Description

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

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

Description

Converts each of the date/time values owned by the CParserPropertyValueMultiDateTime object into universal time which are not already stored in universal time. The function first adds the number of seconds specified in aIncrement, then, the resulting date/time value is modified 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 Pointer to the specification for daylight saving. If any 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 all of the date/time values owned by the CParserPropertyValueMultiDateTime object into the local time for the target machine if they are stored as universal time.

Parameters

const TTimeIntervalSeconds& aIncrement A time interval in seconds to add to a date/time value. This should normally be the universal time offset for the machine's locale.

CArrayPtr<TVersitDateTime>* Value() const;

Description

Gets a pointer to the list of date/time values owned by the CParserPropertyValueMultiDateTime object.

Return value

CArrayPtr<TVersitDateTime>* Pointer to the array of date/time values.