Symbian^3 Application Developer Library >

MSenProperties Class Reference

class MSenProperties
Public Member Functions
HBufC8 * AsUtf8L ()
HBufC8 * AsUtf8LC ()
TInt BoolPropertyL (const TDesC8 &, TBool &)
MSenProperties * Clone ( TInt &)
MSenProperties * CloneL ()
TInt IntPropertyL (const TDesC8 &, TInt &)
TBool IsSafeToCast ( TSenPropertiesClassType )
TSenPropertiesClassType PropertiesClassType ()
TInt PropertyL (const TDesC8 &, TPtrC8 &)
void ReadFromL (const TDesC8 &)
TInt SetBoolPropertyL (const TDesC8 &, const TBool )
TInt SetIntPropertyL (const TDesC8 &, const TInt )
TInt SetPropertyL (const TDesC8 &, const TDesC8 &)
void SetReader ( CSenXmlReader &)
void WriteToL ( RWriteStream &)
Public Member Enumerations
enum TSenPropertiesClassType {
ENotInUse  = 0, ESenXmlProperties  = 1, ESenTransportProperties  = 2, ESenHttpTransportProperties  = 3, ESenVtcpTransportProperties  = 4, ESenLayeredXmlProperties  = 5, ESenLayeredTransportProperties  = 6, ESenLayeredHttpTransportProperties  = 7, ESenLayeredVtcpTransportProperties  = 8
}

Member Functions Documentation

AsUtf8L()

HBufC8 * AsUtf8L ( ) [pure virtual]
Get these properties as UTF-8 charset encoded descriptor.
Since
Series60

AsUtf8LC()

HBufC8 * AsUtf8LC ( ) [pure virtual]
Get these properties as UTF-8 charset encoded descriptor.
Since
Series60

BoolPropertyL(const TDesC8 &, TBool &)

TInt BoolPropertyL ( const TDesC8 & aName,
TBool & aValue
) [pure virtual]
Gets the boolean value of the property behind certain name.
Since
Series60

Parameters

const TDesC8 & aName The name identifying this property.
TBool & aValue A TBool reference to be filled in with the value of the property.

Clone(TInt &)

MSenProperties * Clone ( TInt & aOkOrError ) const [pure virtual]

Method creates exact copy of the properties, preserving the real, concrete subclass type (this can be resolved via PropertiesClassType() method. Furthermore, the IsSafeToCast() method can be used to reflect the returned pointer to a concrete class. NOTE: one must cast the returned pointer to concrete class in order to safely de-allocate any memory allocated by this method.

Parameters

TInt & aOkOrError is KErrNone when clone is successfully allocated, or some system-wide error otherwise.

CloneL()

MSenProperties * CloneL ( ) const [pure virtual]

Method creates exact copy of the properties, preserving the real, concrete subclass type (this can be resolved via PropertiesClassType() method. Furthermore, the IsSafeToCast() method can be used to reflect the returned pointer to a concrete class. NOTE: one must cast the returned pointer to concrete class in order to safely de-allocate any memory allocated by this method.

IntPropertyL(const TDesC8 &, TInt &)

TInt IntPropertyL ( const TDesC8 & aName,
TInt & aValue
) [pure virtual]
Gets the integer value of the property behind certain name.
Since
Series60

Parameters

const TDesC8 & aName The name identifying this property.
TInt & aValue A TInt reference to be filled in with the value of the property.

IsSafeToCast(TSenPropertiesClassType)

TBool IsSafeToCast ( TSenPropertiesClassType aClass ) [pure virtual]

Method provies reflection support for properties classes, enabling safe class-casts to concrete subclass objects.

Parameters

TSenPropertiesClassType aClass

PropertiesClassType()

TSenPropertiesClassType PropertiesClassType ( ) [pure virtual]

Get an integer identifying properties class type. All subclasses MUST return use unique integer value.

PropertyL(const TDesC8 &, TPtrC8 &)

TInt PropertyL ( const TDesC8 & aName,
TPtrC8 & aValue
) [pure virtual]
Gets the value of the property behind certain name.
Since
Series60

Parameters

const TDesC8 & aName The name identifying this property.
TPtrC8 & aValue The value of the property, or KNullDesC8 if property is not found.

ReadFromL(const TDesC8 &)

void ReadFromL ( const TDesC8 & aBuffer ) [pure virtual]
Reads this properties object from the descriptor. UTF-8 charset encoding should be used.
Since
Series60

Parameters

const TDesC8 & aBuffer The buffer to read from.

SetBoolPropertyL(const TDesC8 &, const TBool)

TInt SetBoolPropertyL ( const TDesC8 & aName,
const TBool aValue
) [pure virtual]

Sets new boolean property.

If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.

Since
Series60

Parameters

const TDesC8 & aName Name of the property, which can be later used to refer the given value.
const TBool aValue The boolean value of this property.

SetIntPropertyL(const TDesC8 &, const TInt)

TInt SetIntPropertyL ( const TDesC8 & aName,
const TInt aValue
) [pure virtual]

Sets new integer property.

If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.

Since
Series60

Parameters

const TDesC8 & aName Name of the property, which can be later used to refer the given value.
const TInt aValue Is the integer value of this property.

SetPropertyL(const TDesC8 &, const TDesC8 &)

TInt SetPropertyL ( const TDesC8 & aName,
const TDesC8 & aValue
) [pure virtual]

Sets new property.

If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.

Since
Series60

Parameters

const TDesC8 & aName Name of the property, which can be later used to refer the given value.
const TDesC8 & aValue Is the value of this property.

SetReader(CSenXmlReader &)

void SetReader ( CSenXmlReader & aReader ) [pure virtual]

Sets the XML reader to be used for parsing.

Parameters

CSenXmlReader & aReader

WriteToL(RWriteStream &)

void WriteToL ( RWriteStream & aWriteStream ) [pure virtual]
Writes this properties object as descriptor into a stream. UTF-8 charset encoding will be used.
Since
Series60

Parameters

RWriteStream & aWriteStream The stream to write to.

Member Enumerations Documentation

Enum TSenPropertiesClassType

PropertiesClassType enumeration.

Enumerators

ENotInUse = 0
ESenXmlProperties = 1
ESenTransportProperties = 2
ESenHttpTransportProperties = 3
ESenVtcpTransportProperties = 4
ESenLayeredXmlProperties = 5
ESenLayeredTransportProperties = 6
ESenLayeredHttpTransportProperties = 7
ESenLayeredVtcpTransportProperties = 8

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.