TVersitDateTime Class Reference

#include <app/vprop.h>

Link against: versit.lib

class TVersitDateTime

Public Attributes
TDateTime	iDateTime
TRelativeTime	iRelativeTime

Public Member Enumerations
enum	TRelativeTime { EIsUTC, EIsVCardLocal, EIsMachineLocal, EIsCorrect }
enum	TVersitDateTimeFlags { EExportNullFlag, EExportTimeZoneDesignator, EExportLeaveAsLocalTime }

Public Member Functions
	TVersitDateTime(const TDateTime &, TRelativeTime)
void	ClearFlag(TVersitDateTimeFlags)
TBool	IsFlagSet(TVersitDateTimeFlags)
void	SetFlag(TVersitDateTimeFlags)

Detailed Description

Defines a Versit date and time.

This class is used throughout Versit to represent the date and time. It uses a TDateTime object to store the date/time value and records whether this value is local to the machine which originated the vCard, local to the machine on which the code is running, or universal time (UTC).

The Year(), Month() and Day() member functions of class TDateTime may be used to extract the date and time components from the TVersitDateTime::iDateTime.

Member Attribute Documentation

iDateTime

TDateTime

iDateTime

The date/time value.

iRelativeTime

TRelativeTime

iRelativeTime

Specifies whether the time value is local to the machine which originated the vCard, local to the machine on which the code is running, or universal.

Member Enumeration Documentation

Enum TRelativeTime

Relative time flags.

Enumerator	Value	Description
EIsUTC		Time is stored in UTC.
EIsVCardLocal		Time is local to the machine which originated the vCard.
EIsMachineLocal		Time is local to the machine on which the code is running.
EIsCorrect		Unused.

Enum TVersitDateTimeFlags

Date/time flags. Deprecatedsince 9.1

Enumerator	Value	Description
EExportNullFlag	0
EExportTimeZoneDesignator	0x01	Indicates whether the relative time is to be externalized along with the date/time value. The flag is set to 'EExportNullFlag' by default. This is only implemented (by CParserTimePropertyValue::EncodeVersitDateTimeL()) if the date/time is universal. When the flag is set, the externalised value is followed by the token, KVersitTokenUniversalTime.
EExportLeaveAsLocalTime	0x02

Enumerator

Value

Description

EExportNullFlag

EExportTimeZoneDesignator

0x01

Indicates whether the relative time is to be externalized along with the date/time value.

The flag is set to 'EExportNullFlag' by default.

This is only implemented (by CParserTimePropertyValue::EncodeVersitDateTimeL()) if the date/time is universal. When the flag is set, the externalised value is followed by the token, KVersitTokenUniversalTime.

EExportLeaveAsLocalTime

0x02

Constructor & Destructor Documentation

TVersitDateTime ( const TDateTime &, TRelativeTime )

IMPORT_C	TVersitDateTime	(	const TDateTime &	aDateTime,
			TRelativeTime	aRelativeTime
		)

Constructs the Versit date/time object with a date/time value and a specification of whether this value is local to the machine which originated the vCard, local to the machine on which the code is running, or universal time.