CParserParam Class Reference

class CParserParam : public CBase

A Versit property parameter.

A property parameter consists of a name and optionally a value, both in descriptor form. Parser properties (class CParserProperty ) may own one or more property parameters.

Note:

The private parameter name and value members are stored as narrow (8-bit) rather than 16-bit Unicode descriptors.

However, certain member functions take or return a Unicode value, for the purpose of backwards compatibility. In this case a simple conversion takes place: this ignores the top 8 bits (for Unicode -> Narrow) or adds zero for the top 8-bits (for Narrow->Unicode).

Inherits from

Constructor & Destructor Documentation

CParserParam(HBufC8 *, HBufC8 *)

CParserParam ( HBufC8 * aName,
HBufC8 * aValue
) [private]

Parameters

HBufC8 * aName
HBufC8 * aValue

~CParserParam()

IMPORT_C ~CParserParam ( )

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

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C TInt ExternalizeL ( RWriteStream & aStream ) const

Externalises a property parameter to the stream, in the form NAME=VALUE (or just NAME, depending on whether there is a value).

This function performs the esacaping of characters.

Parameters

RWriteStream & aStream Stream to which the property parameter is to be externalised.

ExternalizeL(RWriteStream &, TInt &, CVersitParser *)

IMPORT_C TInt ExternalizeL ( RWriteStream & aStream,
TInt & aLengthOutput,
CVersitParser * aVersitParser
) const

Externalises vCard3.0 property parameter to the stream, in the form NAME=VALUE or just VALUE, if it is a nameless parameter.

This function performs the esacaping of characters.

Parameters

RWriteStream & aStream
TInt & aLengthOutput
CVersitParser * aVersitParser

Name()

IMPORT_C TPtrC8 Name ( ) const

Gets the property parameter name.

If no name has been set, the function returns an empty string.

NewL(const TDesC8 &, const TDesC8 &)

IMPORT_C CParserParam * NewL ( const TDesC8 & aName,
const TDesC8 & aValue
) [static]

Allocates and constructs a new property parameter with the name and value specified.

This object does does not take ownership of aName or aValue.

Parameters

const TDesC8 & aName The parameter name.
const TDesC8 & aValue The parameter value. Use KNullDesC8 if not applicable.

NewL(const TDesC8 &, const TDesC &)

IMPORT_C CParserParam * NewL ( const TDesC8 & aName,
const TDesC & aValue
) [static]

Allocates and constructs a new property parameter with the name and value specified.

This object does does not take ownership of aName or aValue.

A Unicode value string is converted to a narrow string for storage.

Parameters

const TDesC8 & aName The parameter name.
const TDesC & aValue The parameter value. (Use KNullDesC if applicable).

SetValueL(const TDesC8 &)

IMPORT_C void SetValueL ( const TDesC8 & aValue )

Sets the property parameter value.

Parameters

const TDesC8 & aValue The new property parameter value.

SetValueL(HBufC8 *)

IMPORT_C void SetValueL ( HBufC8 * aValue )

Sets the property parameter value.

The property parameter takes ownership of aValue.

Parameters

HBufC8 * aValue The new property parameter value.

Value()

IMPORT_C TPtrC8 Value ( ) const

Gets the property parameter value.

If no value has been set, the function returns an empty descriptor.

ValueL()

IMPORT_C HBufC * ValueL ( ) const

Gets the property parameter value as a Unicode heap descriptor.

If no value has been set, the function returns an empty descriptor.

Member Data Documentation

HBufC8 * iParamName

HBufC8 * iParamName [private]

HBufC8 * iValue

HBufC8 * iValue [private]