Class CParserParam

CParserParam

Support

Supported from 5.0

Description

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

Derivation

CBase Base class for all classes to be instantiated on the heap CParserParam A versit property parameter

Defined in CParserParam:
EscapeParameter(), Name(), NewL(), SetValueL(), Value(), ~CParserParam()

Inherited from CBase:
operator new()

CParserParam* NewL(const TDesC& aName,const TDesC* aValue);

Description

Allocates and constructs a new property parameter with the name and value specified. The property parameter does not take ownership of the name or value.

Parameters

const TDesC& aName The parameter name. const TDesC* aValue Pointer to the parameter value. NULL if not applicable.

Return value

CParserParam* Pointer to the newly created property parameter.

~CParserParam();

Description

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

TPtrC Name() const;

Description

Gets the property parameter name. If no name has been set, the function returns an empty descriptor.

Return value

TPtrC The property parameter name.

TPtrC Value() const;

Description

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

Return value

TPtrC The property parameter value.

void SetValueL(const TDesC& aValue);

Description

Sets the property parameter value.

Any existing value is replaced by the value specified. The property parameter does not take ownership of aValue.

Parameters

const TDesC& aValue The new property parameter value.

static void EscapeParameter(const TDesC& aSource, TDes& aDestination);

Support

Supported from 5.1

Description

Adds a backslash character to the property parameter value to escape any semi-colons or backslashes in the value. Used when externalising a property parameter value to a write stream.

Parameters

const TDesC& aSource The source string — holds the property parameter value. TDes& aDestination The target string, with any escape characters added.