Symbian^3 Application Developer Library >

CIMPSSAPKeyValuePair Class Reference

class CIMPSSAPKeyValuePair : public CBase

Key - value container. Can be derived to expand services.

Since
3.0

Inherits from

Public Member Functions
~CIMPSSAPKeyValuePair ()
TInt DataSize ()
TInt DataSizeDec ()
void ExternalizeL ( RWriteStream &)
TInt GetValue ( TInt &)
TInt GetValue ( TPtrC8 &)
TInt GetValue ( TPtrC16 &)
TBool IsDataTooBig ()
const TDesC & Key ()
HBufC * KeyValuePairFlatLC ()
CIMPSSAPKeyValuePair * New (const TDesC &)
CIMPSSAPKeyValuePair * NewLC ( RReadStream &)
CIMPSSAPKeyValuePair * NewLC (const TDesC &)
TInt SetValue ( TInt )
TInt SetValue (const TDesC8 &)
TInt SetValue (const TDesC16 &)
Protected Member Functions
CIMPSSAPKeyValuePair ()
void ConstructL ( RReadStream &)
Private Member Functions
void ParseFlatKeyValuePairL (const TDesC &)
void Reset ()
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()
Public Member Enumerations
enum TValueType { EValueTypeNone  = 0, EValueTypeInt , EValueTypeDesC8 , EValueTypeDesC16 }
Public Attributes
HBufC16 * iBuf16
HBufC8 * iBuf8
TInt iInt
Private Attributes
union CIMPSSAPKeyValuePair::@29 @30
HBufC16 * iKey
TValueType iValueType

Constructor & Destructor Documentation

CIMPSSAPKeyValuePair()

CIMPSSAPKeyValuePair ( ) [protected]

C++ default constructor.

~CIMPSSAPKeyValuePair()

~CIMPSSAPKeyValuePair ( ) [virtual]

Destructor.

Member Functions Documentation

ConstructL(RReadStream &)

void ConstructL ( RReadStream & aStream ) [protected]

Symbian OS constructor. Initializes object state from given stream.

Since
3.0

Parameters

RReadStream & aStream The stream to read object state.

DataSize()

TInt DataSize ( ) const

Approximates the value pair data size.

Since
3.0

DataSizeDec()

TInt DataSizeDec ( ) const

Approximates the value pair data size in decimal textual representation

Since
3.0

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const

Externalises the value pair to given stream.

Since
3.0

Parameters

RWriteStream & aStream stream to write to.

GetValue(TInt &)

TInt GetValue ( TInt & aValue ) const

Data getters.

Overloaded to support integer type and narrow and wide descriptors.

Since
3.0

Parameters

TInt & aValue The value to get.

GetValue(TPtrC8 &)

TInt GetValue ( TPtrC8 & aValue ) const

Parameters

TPtrC8 & aValue

GetValue(TPtrC16 &)

TInt GetValue ( TPtrC16 & aValue ) const

Parameters

TPtrC16 & aValue

IsDataTooBig()

TBool IsDataTooBig ( ) const

Checks if the data fits in the flat descriptor

Since
3.0

Key()

const TDesC & Key ( ) const [virtual]

Key accessor.

Gets the key associated with key-value object. Virtual to allow derived classes to expand behaviour.

Since
3.0

KeyValuePairFlatLC()

HBufC * KeyValuePairFlatLC ( )

Key-Value pair flat representation

Creates flat representation of the key-value pair and pushes it in cleanup stack. Ownership is transferred to calling method.

Since
3.0

New(const TDesC &)

CIMPSSAPKeyValuePair * New ( const TDesC & aKey ) [static]

Non leaving two phased constructor.

If object allocation fails, returns NULL.

Since
3.0

Parameters

const TDesC & aKey The key.

NewLC(RReadStream &)

CIMPSSAPKeyValuePair * NewLC ( RReadStream & aStream ) [static]

Two phased constructor initializing object state from the stream.

Since
3.0

Parameters

RReadStream & aStream The stream to read object state.

NewLC(const TDesC &)

CIMPSSAPKeyValuePair * NewLC ( const TDesC & aKeyValuePairFlat ) [static]

Two phased constructor initializing object state from given flat descriptor.

Since
3.0

Parameters

const TDesC & aKeyValuePairFlat The flat representation of key-value pair

ParseFlatKeyValuePairL(const TDesC &)

void ParseFlatKeyValuePairL ( const TDesC & aKeyValuePairFlat ) [private]
Parses value pair data from flat descriptor.
Since
3.0

Parameters

const TDesC & aKeyValuePairFlat flat descriptor to parse

Reset()

void Reset ( ) [private]
Resets the value pair data.
Since
3.0

SetValue(TInt)

TInt SetValue ( TInt aValue )

Data setters.

Overloaded to support integer type and narrow and wide descriptors.

Since
3.0

Parameters

TInt aValue The value to assign for key-value object.

SetValue(const TDesC8 &)

TInt SetValue ( const TDesC8 & aValue )

Parameters

const TDesC8 & aValue

SetValue(const TDesC16 &)

TInt SetValue ( const TDesC16 & aValue )

Parameters

const TDesC16 & aValue

Member Enumerations Documentation

Enum TValueType

Data type enumeration. List supported value data types.
Since
3.0

Enumerators

EValueTypeNone = 0
EValueTypeInt
EValueTypeDesC8
EValueTypeDesC16

Member Data Documentation

union CIMPSSAPKeyValuePair::@29 @30

union CIMPSSAPKeyValuePair::@29 @30 [private]

HBufC16 * iBuf16

HBufC16 * iBuf16

HBufC8 * iBuf8

HBufC8 * iBuf8

TInt iInt

TInt iInt

HBufC16 * iKey

HBufC16 * iKey [private]

TValueType iValueType

TValueType iValueType [private]

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.