EPOC   SDK Home Glossary Indexes Previous Next Up

CParserParam class


Contents


CParserParam class — Property parameter

Section Contents


Overview

Compatability

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behaviour.

Defined in

vprop.h

Link against

versit.lib

Description

A generic property parameter class, consisting of a name and optionally a value, both in descriptor form.

A parser property (class CParserProperty) may own one or more property parameters.


Construction and destruction


NewL() — Allocate and construct

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

Description

Use this function to allocate and construct a new property parameter with the name and value specified. The property parameter does not take ownership of the name or value.

Arguments

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() — Destructor

~CParserParam();

Description

The destructor frees all resources owned by the property parameter, prior to its destruction.


Name and value


Name() — Get the parameter name

TPtrC Name() const;

Description

Retrieves the property parameter name.

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

Return value

TPtrC

The property parameter name.


Value() — Get the parameter value

TPtrC Value() const;

Description

Retrieves the property parameter value.

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

Return value

TPtrC

The property parameter value.


SetValueL() — Set the 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.

Arguments

const TDesC& aValue

The new property parameter value.

EPOC       SDK Home Glossary Indexes Previous Next Up