CParserParam Class Reference

#include <app/vprop.h>

Link against: versit.lib

class CParserParam : public CBase

Inherits from

  • CParserParam
    Public Member Functions
    ~CParserParam()
    IMPORT_C TIntExternalizeL(RWriteStream &)
    IMPORT_C TIntExternalizeL(RWriteStream &, TInt &, CVersitParser *)
    IMPORT_C TPtrC8Name()
    IMPORT_C CParserParam *NewL(const TDesC8 &, const TDesC8 &)
    IMPORT_C CParserParam *NewL(const TDesC8 &, const TDesC &)
    IMPORT_C voidSetValueL(const TDesC8 &)
    IMPORT_C voidSetValueL(HBufC8 *)
    IMPORT_C TPtrC8Value()
    IMPORT_C HBufC *ValueL()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

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

    Constructor & Destructor Documentation

    ~CParserParam ( )

    IMPORT_C~CParserParam()

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

    Member Function Documentation

    ExternalizeL ( RWriteStream & )

    IMPORT_C TIntExternalizeL(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.

    ParameterDescription
    aStreamStream to which the property parameter is to be externalised.

    Returns: The length of data written to the stream.

    ExternalizeL ( RWriteStream &, TInt &, CVersitParser * )

    IMPORT_C TIntExternalizeL(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.

    Name ( )

    IMPORT_C TPtrC8Name()const

    Gets the property parameter name.

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

    Returns: The property parameter name.

    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.

    ParameterDescription
    aNameThe parameter name.
    aValueThe parameter value. Use KNullDesC8 if not applicable.

    Returns: Pointer to the newly created property parameter.

    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.

    ParameterDescription
    aNameThe parameter name.
    aValueThe parameter value. (Use KNullDesC if applicable).

    Returns: Pointer to the newly created property parameter.

    SetValueL ( const TDesC8 & )

    IMPORT_C voidSetValueL(const TDesC8 &aValue)

    Sets the property parameter value.

    ParameterDescription
    aValueThe new property parameter value.

    SetValueL ( HBufC8 * )

    IMPORT_C voidSetValueL(HBufC8 *aValue)

    Sets the property parameter value.

    The property parameter takes ownership of aValue.

    ParameterDescription
    aValueThe new property parameter value.

    Value ( )

    IMPORT_C TPtrC8Value()const

    Gets the property parameter value.

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

    Returns: The property parameter value.

    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.

    Returns: A Unicode version of the property parameter value.

    © Nokia 2011.