CParserPropertyValueHBufC Class Reference

#include <app/vprop.h>

Link against: versit.lib

class CParserPropertyValueHBufC : public CParserPropertyValue

Inherits from

Detailed 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.

Member Attribute Documentation

iValue

HBufC *iValue[protected]

Constructor & Destructor Documentation

CParserPropertyValueHBufC ( HBufC16 * )

IMPORT_CCParserPropertyValueHBufC(HBufC16 *aValue)

~CParserPropertyValueHBufC ( )

IMPORT_C~CParserPropertyValueHBufC()

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

Member Function Documentation

ExternalizeL ( RWriteStream &, const Versit::TEncodingAndCharset &, TInt )

IMPORT_C voidExternalizeL(RWriteStream &aStream,
const Versit::TEncodingAndCharset &aEncodingCharset,
TIntaLengthOutput
)[virtual]

Externalizes the descriptor property value into aStream.

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

ParameterDescription
aStreamStream into which the value is to be externalised.
aEncodingCharsetSpecifies the character set and encoding information.
aLengthOutputThe 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.

IsAsciiCharacterSetSufficient ( )

IMPORT_C TBoolIsAsciiCharacterSetSufficient()[virtual]

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

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

NewL ( const TDesC & )

IMPORT_C CParserPropertyValueHBufC *NewL(const TDesC &aValue)[static]

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

Sets the property value's UID to KVersitPropertyHBufCUid.

ParameterDescription
aValueThe property value.

Returns: Pointer to the newly created heap descriptor property value.

TakeValueOwnership ( )

IMPORT_C HBufC *TakeValueOwnership()

Take ownership of the heap descriptor property value.

The property value previously owned by the object is deleted.

Returns: A pointer to the property value.

TreatAsArrayPropertyLC ( const CParserProperty & )

IMPORT_C CParserPropertyValueCDesCArray *TreatAsArrayPropertyLC(const CParserProperty &aOwningProperty)const

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.

ParameterDescription
aOwningPropertyThe property that contains this property value.

Returns: An array-based representation of this object.

Value ( )

IMPORT_C TPtrCValue()const

Retrieves the property value.

Returns: Pointer descriptor representing the property value.