CSubConParameterFamily Class Reference

class CSubConParameterFamily : public CBase

Container of RSubConnection parameter sets.

For each Parameter Type (Requested, Acceptable and Granted) it contains one generic and 0..N extended parameter sets.

Note: a CSubConParameterBundle or RSubConParameterBundle object can take ownership of a CSubConParameterFamily object, in this case, when the bundle is destroyed, this family object will also be destroyed (along with any parameter sets that are owned by the family).

THIS API IS DEPRECATED IN FAVOUR OF RParameterFamily

since v9.6

Inherits from

  • CSubConParameterFamily
Public Member Functions
~CSubConParameterFamily()
IMPORT_C voidAddExtensionSetL(CSubConExtensionParameterSet &, TParameterSetType)
IMPORT_C voidClearAllParameters(TParameterSetType)
voidCopyFromFamilyL(RParameterFamily &)
voidCopyToFamilyL(RParameterFamily &)
IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(TUid, TParameterSetType)
IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(STypeId, TParameterSetType)
IMPORT_C CSubConGenericParameterSet *GetGenericSet(TParameterSetType)
TUint32 Id()
IMPORT_C TUintLength()
IMPORT_C TIntLoad(TPtrC8 &)
IMPORT_C CSubConParameterFamily *LoadL(RSubConParameterBundle &, TPtrC8 &)
IMPORT_C CSubConParameterFamily *LoadL(CSubConParameterBundle &, TPtrC8 &)
IMPORT_C CSubConParameterFamily *NewL(RSubConParameterBundle &, TUint32)
IMPORT_C CSubConParameterFamily *NewL(CSubConParameterBundle &, TUint32)
IMPORT_C voidSetGenericSetL(CSubConGenericParameterSet &, TParameterSetType)
IMPORT_C TIntStore(TDes8 &)
Protected Member Functions
CSubConParameterFamily(TUint32)
IMPORT_C voidConstructL(RSubConParameterBundle &)
IMPORT_C voidConstructL(CSubConParameterBundle &)
IMPORT_C TInt32ExtractFamilyAndCreateBufferL(TPtrC8 &, TPtrC8 &)
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
enumTParameterSetType { ERequested = 0, EAcceptable = 1, EGranted = 2, ENumValues = 3 }
Protected Attributes
RMetaDataEComContaineriExtensionSets
Private Attributes
const TUint32iFamilyId
RMetaDataEComContaineriGenericSets

Constructor & Destructor Documentation

CSubConParameterFamily(TUint32)

IMPORT_CCSubConParameterFamily(TUint32aFamilyId)[protected, explicit]

Parameters

TUint32 aFamilyId

~CSubConParameterFamily()

IMPORT_C~CSubConParameterFamily()[virtual]

Member Functions Documentation

AddExtensionSetL(CSubConExtensionParameterSet &, TParameterSetType)

IMPORT_C voidAddExtensionSetL(CSubConExtensionParameterSet &aExtensionSet,
TParameterSetTypeaType
)

Parameters

CSubConExtensionParameterSet & aExtensionSet
TParameterSetType aType

ClearAllParameters(TParameterSetType)

IMPORT_C voidClearAllParameters(TParameterSetTypeaType)

Parameters

TParameterSetType aType

ConstructL(RSubConParameterBundle &)

IMPORT_C voidConstructL(RSubConParameterBundle &aBundle)[protected]

Parameters

RSubConParameterBundle & aBundle

ConstructL(CSubConParameterBundle &)

IMPORT_C voidConstructL(CSubConParameterBundle &aBundle)[protected]

Parameters

CSubConParameterBundle & aBundle

CopyFromFamilyL(RParameterFamily &)

voidCopyFromFamilyL(RParameterFamily &aSrc)

Copy the parameters of this CSubConParameterFamily from a RParameterFamily.

Parameters

RParameterFamily & aSrcRParameterFamily object to copy from

CopyToFamilyL(RParameterFamily &)

voidCopyToFamilyL(RParameterFamily &aDest)const

Copy the parameters of this CSubConParameterFamily to a RParameterFamily.

Parameters

RParameterFamily & aDestRParameterFamily object to copy to

ExtractFamilyAndCreateBufferL(TPtrC8 &, TPtrC8 &)

IMPORT_C TInt32ExtractFamilyAndCreateBufferL(TPtrC8 &aBuffer,
TPtrC8 &aContainerBuffer
)[protected, static]

Parameters

TPtrC8 & aBuffer
TPtrC8 & aContainerBuffer

FindExtensionSet(TUid, TParameterSetType)

IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(TUidaSetId,
TParameterSetTypeaType
)

Parameters

TUid aSetId
TParameterSetType aType

FindExtensionSet(STypeId, TParameterSetType)

IMPORT_C CSubConExtensionParameterSet *FindExtensionSet(STypeIdaSetId,
TParameterSetTypeaType
)

Parameters

STypeId aSetId
TParameterSetType aType

GetGenericSet(TParameterSetType)

IMPORT_C CSubConGenericParameterSet *GetGenericSet(TParameterSetTypeaType)

Parameters

TParameterSetType aType

Id()

TUint32 Id()[inline]

Fetch the identity of the sub-connection parameter family

Length()

IMPORT_C TUintLength()const

Load(TPtrC8 &)

IMPORT_C TIntLoad(TPtrC8 &aDes)

Parameters

TPtrC8 & aDes

LoadL(RSubConParameterBundle &, TPtrC8 &)

IMPORT_C CSubConParameterFamily *LoadL(RSubConParameterBundle &aBundle,
TPtrC8 &aBuffer
)[static]

Parameters

RSubConParameterBundle & aBundle
TPtrC8 & aBuffer

LoadL(CSubConParameterBundle &, TPtrC8 &)

IMPORT_C CSubConParameterFamily *LoadL(CSubConParameterBundle &aBundle,
TPtrC8 &aBuffer
)[static]

Parameters

CSubConParameterBundle & aBundle
TPtrC8 & aBuffer

NewL(RSubConParameterBundle &, TUint32)

IMPORT_C CSubConParameterFamily *NewL(RSubConParameterBundle &aBundle,
TUint32aFamilyId
)[static]

Parameters

RSubConParameterBundle & aBundle
TUint32 aFamilyId

NewL(CSubConParameterBundle &, TUint32)

IMPORT_C CSubConParameterFamily *NewL(CSubConParameterBundle &aBundle,
TUint32aFamilyId
)[static]

Parameters

CSubConParameterBundle & aBundle
TUint32 aFamilyId

SetGenericSetL(CSubConGenericParameterSet &, TParameterSetType)

IMPORT_C voidSetGenericSetL(CSubConGenericParameterSet &aGenericSet,
TParameterSetTypeaType
)

Parameters

CSubConGenericParameterSet & aGenericSet
TParameterSetType aType

Store(TDes8 &)

IMPORT_C TIntStore(TDes8 &aDes)const

Parameters

TDes8 & aDes

Member Enumerations Documentation

Enum TParameterSetType

Enumerators

ERequested = 0
EAcceptable = 1
EGranted = 2
ENumValues = 3

Member Data Documentation

RMetaDataEComContainer iExtensionSets

RMetaDataEComContaineriExtensionSets[protected]

const TUint32 iFamilyId

const TUint32iFamilyId[private]

RMetaDataEComContainer iGenericSets

RMetaDataEComContaineriGenericSets[private]