![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
CBase |
Abstract: CBase behaviour. |
vprop.h
versit.lib
Represents a versit property. Stores the property name, the property value and, optionally, one or more property parameters. Derived classes are identified by a UID, specified in the CParserPropertyValue passed to the NewL() function. Grouped properties are supported by the derived class, CParserGroupedProperty.
Versit properties have the general form:
where items in brackets are optional and * indicates that the item may be repeated
e.g.
TEL; HOME; ENCODING=QUOTED-PRINTABLE; CHARSET=US-ASCII : 01234 567890
Here, TEL is the property name, HOME, ENCODING and CHARSET are property parameter names and QUOTED-PRINTABLE and US-ASCII are property parameter values. The component following the colon is the property value.
CParserProperty* NewL(CParserPropertyValue* aPropertyValue, const TDesC& aName, CArrayPtr<CParserParam>* aArrayOfParams);
Use this function to allocate and construct a new versit property from the value, name and property parameter array specified.
CParserPropertyValue* aPropertyValue |
Pointer to the property value. |
const TDesC& aName |
The property name. |
CArrayPtr<CParserParam>* aArrayOfParams |
Pointer to the property parameters. The property takes ownership of the array of parameters. NULL if the property has no parameters. |
CParserProperty* |
Pointer to the newly created property. |
CParserProperty* NewLC(CParserPropertyValue* aPropertyValue, const TDesC& aName, CArrayPtr<CParserParam>* aArrayOfParams);
Use this function to allocate and construct a new versit property from the value, name and property parameter array specified. The property is left on the cleanup stack.
CParserPropertyValue* aPropertyValue |
Pointer to the property value. |
const TDesC& aName |
The property name. |
CArrayPtr<CParserParam>* aArrayOfParams |
Pointer to the property parameters. The parser property object takes ownership of the array of parameters. NULL if the property has no parameters. |
CParserProperty* |
Pointer to the newly created parser property. |
~CParserProperty();
The destructor frees all resources owned by the property, prior to its destruction.
TPtrC Name() const;
Use this function to retrieve the property name.
If no name has been set, the function returns an empty descriptor.
TPtrC |
The property name. |
void SetNameL(const TDesC& aName);
Use this function to set the property name. If a name has already been set, this function will replace it.
const TDesC& aName |
The new property name. |
This function allocates and constructs a new HBufC descriptor on the heap and initialises it using the content of aName, so can leave if insufficient memory is available.
void AddParamL(CParserParam* aParam);
Use this function to add a property parameter to the property. Any existing parameter with the same name is replaced.
The parameter is appended to the property's parameter array. If no property parameter array has been allocated, the function will first allocate one.
CParserParam* aParam |
Pointer to a generic property parameter, consisting of a name and optionally a value, both specified as descriptors. The property takes ownership of the new parameter. |
void DeleteParam(TDesC& aParamName);
Use this function to delete the specified property parameter from the property's array of parameters, if it exists in the array.
TDesC& aParamName |
The name of the parameter to delete. |
CParserParam* Param(const TDesC& aParamName) const;
Use this function to retrieve a pointer to the property parameter with the specified name.
const TDesC& aParamName |
The name of the parameter to search for. |
CParserParam* |
Pointer to a property parameter. NULL if the parameter name specified is not found in the array. |
CParserPropertyValue* Value() const;
Use this function to retrieve a pointer to the property value.
CParserPropertyValue* |
Pointer to generic parser property value. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |