Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: vcard.h
Link against: versit.lib

Class CParserVCard

CParserVCard

Support

Supported from 5.0

Description

A vCard parser. In addition to the functions inherited from CVersitParser, it provides support for property groups and agents.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CParserVCardA vCard parser
CVersitParservCalendar or vCard parser

Defined in CParserVCard:
CParserVCard(), ConvertAllPropertyDateTimesToMachineLocalL(), ExternalizeL(), GroupOfPropertiesL(), InternalizeL()

Inherited from CBase:
operator new()

Inherited from CVersitParser:
AddEntityL(), AddPropertyL(), ArrayOfEntities(), ArrayOfProperties(), DefaultCharSet(), DefaultEncoding(), EBIG5CharSet, EEUCJPCharSet, EGB231280CharSet, EGBKCharSet, EISO2022JPCharSet, EISO885910CharSet, EISO88591CharSet, EISO88592CharSet, EISO88593CharSet, EISO88594CharSet, EISO88595CharSet, EISO88597CharSet, EISO88599CharSet, EShiftJISCharSet, EUSAsciiCharSet, EUTF7CharSet, EUTF8CharSet, EntityL(), EntityName(), IsValidLabel(), IsValidParameterValue(), PropertyL(), SetDefaultCharSet(), SetDefaultEncoding(), SetEntityNameL(), SetParamCharType(), TVersitCharSet


Construction


CParserVCard()

CParserVCard();

Description

Constructs a vCard parser.

[Top]


Stream persistence


ExternalizeL()

void ExternalizeL(RWriteStream& aStream);

Description

Externalises a vCard entity (and all sub-entities) to a write stream. Also converts all date/time values from machine-local into universal time. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class. Sets the entity name to KVersitVarTokenVCARD if it hasn’t already been set.

Parameters

RWriteStream& aStream

Stream to which the vCard entity should be externalised.


InternalizeL()

void InternalizeL(RReadStream& aStream);

Description

Internalises a vCard entity from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class. All date/time property values contained in the vCard entity are converted into machine local date/time values.

Parameters

RReadStream& aStream

Stream from which the vCard entity should be internalised.

[Top]


Properties


ConvertAllPropertyDateTimesToMachineLocalL()

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

Description

Converts all date/time property values contained in the vCard entity into machine local values, including all date/time values contained in agent properties.

Parameters

const TTimeIntervalSeconds& aIncrement

A time interval in seconds to add to the date/time.

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.


GroupOfPropertiesL()

CArrayPtr<CParserProperty>* GroupOfPropertiesL(const TDesC& aGroupName) const;

Description

Gets the named property group from the vCard entity. A property group is a collection of related properties, identified by a group name.

Parameters

const TDesC& aGroupName

The name of the property group of interest.

Return value

CArrayPtr<CParserProperty>*

Array of pointers to the properties contained in the named group. NULL if no matching property group was found.