Class CParserPropertyValueHBufC

class CParserPropertyValueHBufC : public CParserPropertyValue;

Description

A heap descriptor property value parser.

Many properties are stored using this class. Examples are vCard e-mails and vCalendar locations.

The UID for a heap descriptor property value is KVersitPropertyHBufCUid.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CParserPropertyValue - Abstract base class for all property values

• CParserPropertyValueHBufC - A heap descriptor property value parser

Members

Defined in CParserPropertyValueHBufC:
CParserPropertyValueHBufC(), ExternalizeL(), IsAsciiCharacterSetSufficient(), NewL(), TakeValueOwnership(), TreatAsArrayPropertyLC(), Value(), iValue, ~CParserPropertyValueHBufC()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CParserPropertyValue:
Append(), EncodeL(), FoldAndWriteValueToStreamL(), FoldEncodeAndWriteValueToStreamL(), PlugIn(), SetPlugIn(), SupportsInterface(), Uid()

static IMPORT_C CParserPropertyValueHBufC *NewL(const TDesC &aValue);

Description

Allocates and constructs a new heap descriptor property value with a descriptor.

Sets the property value's UID to KVersitPropertyHBufCUid.

Parameters

const TDesC &aValue The property value.

Return value

CParserPropertyValueHBufC * Pointer to the newly created heap descriptor property value.

IMPORT_C CParserPropertyValueHBufC(HBufC16 *aValue);

Description

Parameters

HBufC16 *aValue

IMPORT_C ~CParserPropertyValueHBufC();

Description

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

IMPORT_C TPtrC Value() const;

Description

Retrieves the property value.

Return value

TPtrC Pointer descriptor representing the property value.

IMPORT_C HBufC *TakeValueOwnership();

Description

Take ownership of the heap descriptor property value.

The property value previously owned by the object is deleted.

Return value

HBufC * A pointer to the property value.

IMPORT_C CParserPropertyValueCDesCArray *TreatAsArrayPropertyLC(const CParserProperty &aOwningProperty) const;

Description

Treats this HBufC-based property value as a possible array-based property.

This function was added for compatibility reasons to support array-based SOUND property values. This does not alter the representation of this parser property value.

If the underlying HBufC value cannot be parsed into any array elements, then this method returns an array containing only a single item. Otherwise, the HBufC is split into its constituent elements and returned as an array.

Parameters

const CParserProperty &aOwningProperty The property that contains this property value.

Return value

CParserPropertyValueCDesCArray * An array-based representation of this object.

virtual IMPORT_C TBool IsAsciiCharacterSetSufficient();

Description

Tests whether the property value can be represented using the ASCII character set.

Return value

TBool ETrue if the property value can be represented using the ASCII character set. If not, EFalse.

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream, const Versit::TEncodingAndCharset &aEncodingCharset, TInt aLengthOutput);

Description

Externalizes the descriptor property value into aStream.

This function is invoked by the parser's ExternalizeL() function.

Parameters

RWriteStream &aStream Stream into which the value is to be externalised. const Versit::TEncodingAndCharset &aEncodingCharset Specifies the character set and encoding information. TInt aLengthOutput The amount of text that has been output so far on the line, which needs to be taken into account when calculating if and where any line break should occur.

protected: HBufC * iValue;

Description