CParameterBundle Class Reference

#include <comms-infras/es_parameterbundle.h>

Link against: esock.lib

class CParameterBundle : public CParameterBundleBase

Inherits from

CParameterBundle
- CParameterBundleBase

Public Member Functions
PARAMSETCONTAINERTYPE *	FindParamSetContainer(TUint32)
PARAMSETCONTAINERTYPE *	GetParamSetContainer(TInt)
const PARAMSETCONTAINERTYPE *	GetParamSetContainer(TInt)
TInt	Load(const TDesC8 &)
SUBCLASS *	LoadL(TDesC8 &)
SUBCLASS *	NewL()

Protected Member Functions
	CParameterBundle()

Inherited Attributes
	CParameterBundleBase::iSetContainers

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()
	CParameterBundleBase::AddParamSetContainer(CParameterSetContainer &)
	CParameterBundleBase::AddParamSetContainerL(CParameterSetContainer &)
	CParameterBundleBase::CParameterBundleBase()
	CParameterBundleBase::CountParamSetContainers()const
	CParameterBundleBase::FindParamSetContainer(TUint32)const
	CParameterBundleBase::FindParameterSet(const Meta::STypeId &)
	CParameterBundleBase::FindParameterSet(const Meta::STypeId &)const
	CParameterBundleBase::Length()const
	CParameterBundleBase::RemoveParamSetContainer(TInt)
	CParameterBundleBase::ReplaceParamSetContainer(CParameterSetContainer ,CParameterSetContainer )
	CParameterBundleBase::ReplaceParamSetContainerL(CParameterSetContainer ,CParameterSetContainer )
	CParameterBundleBase::Store(TDes8 &)const
	CParameterBundleBase::~CParameterBundleBase()

Detailed Description

Container for (bundle of) parameter set containers.

This class can't be used directly, but must be subclassed, as the NewL/LoadL refer to the subclass.

May contain and 0..N parameter families of type PARAMSETCONTAINERTYPE.

Constructor & Destructor Documentation

CParameterBundle ( )

CParameterBundle

(

)

[protected, inline]

Member Function Documentation

FindParamSetContainer ( TUint32 )

PARAMSETCONTAINERTYPE *

FindParamSetContainer

(

TUint32

aContainerId

)

[inline]

Reimplemented from CParameterBundleBase::FindParamSetContainer(TUint32)

Search the parameter bundle for a parameter set container

Parameter	Description
aContainerId	Id of the container to match against

Returns: Matching container or NULL pointer if not found

GetParamSetContainer ( TInt )

PARAMSETCONTAINERTYPE *

GetParamSetContainer

(

TInt

aIndex

)

[inline]

Reimplemented from CParameterBundleBase::GetParamSetContainer(TInt)

Pick out the parameter set container at the given index in the bundle.

Parameter	Description
aIndex	index of the container to get

Returns: Matching container or NULL pointer if index out of range

GetParamSetContainer ( TInt )

const PARAMSETCONTAINERTYPE *

GetParamSetContainer

(

TInt

aIndex

)

const [inline]

Reimplemented from CParameterBundleBase::GetParamSetContainer(TInt)const

Load ( const TDesC8 & )

TInt

Load

(

const TDesC8 &

aDes

)

[inline]

Instructs this sub-connection bundle to set its members based on the serialiesd data in the buffer passed.

Parameter	Description
aDes	Buffer containing the serialised bundle object

Returns: KErrNone if successful, otherwise system wide error

LoadL ( TDesC8 & )

SUBCLASS *

LoadL

(

TDesC8 &

aDes

)

[static, inline]

Creates a new parameter set bundle from a buffer containing the serialised object.

Parameter	Description
aDes	Buffer containing the serialised object information

Returns: a pointer to a parameter bundle if successful, otherwise leaves with system error code.

NewL ( )

SUBCLASS *

NewL

(

)

[static, inline]

Reimplemented from CParameterBundleBase::NewL()

Creates a new instance of a parameter bundle (heap object).

Exceptions

leaves

with KErrNoMemory in out of memory conditions

Returns: newly created instance of a parameter bundle