CParameterBundle Class Reference

#include <comms-infras/es_parameterbundle.h>

Link against: esock.lib

class CParameterBundle : public CParameterBundleBase

Inherits from

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(TUint32aContainerId)[inline]

Search the parameter bundle for a parameter set container

ParameterDescription
aContainerIdId of the container to match against

Returns: Matching container or NULL pointer if not found

GetParamSetContainer ( TInt )

PARAMSETCONTAINERTYPE *GetParamSetContainer(TIntaIndex)[inline]

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

ParameterDescription
aIndexindex of the container to get

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

GetParamSetContainer ( TInt )

const PARAMSETCONTAINERTYPE *GetParamSetContainer(TIntaIndex)const [inline]

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.

ParameterDescription
aDesBuffer 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.

ParameterDescription
aDesBuffer 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