Collapse all Symbian^3 Application Developer Library

RSubConParameterBundle Class Reference

class RSubConParameterBundle

Container for (bundle of) SubConnection parameter families.

May contain and 0..N SubConnection parameter families.

Note: If the RSubConParameterBundle object takes ownership of any CSubConParameterFamily object, then when the bundle object is destroyed, any family owned by this object will also be destroyed.

THIS API IS DEPRECATED IN FAVOUR OF RParameterFamilyBundle

since v9.6

Public Member Functions
	RSubConParameterBundle ()
IMPORT_C void	AddFamilyL ( CSubConParameterFamily *)
IMPORT_C void	ClearAllParameters ( CSubConParameterFamily::TParameterSetType )
IMPORT_C void	Close ()
void	CopyFromFamilyBundleL ( RParameterFamilyBundle &)
void	CopyToFamilyBundleL ( RParameterFamilyBundle &)
IMPORT_C CSubConParameterFamily *	FindFamily ( TUint32 )
IMPORT_C TUint	Length ()
IMPORT_C TInt	Load (const TDesC8 &)
IMPORT_C TInt	Store ( TDes8 &)

Protected Member Functions
TInt	CheckBundle ()

Private Member Functions
	RSubConParameterBundle (const RSubConParameterBundle &)
RSubConParameterBundle &	operator= (const RSubConParameterBundle &)

Private Attributes
CSubConParameterBundle *	iBundle

Constructor & Destructor Documentation

RSubConParameterBundle()

IMPORT_C

RSubConParameterBundle

(

)

Empty sub-connection parameter bundle constructor

RSubConParameterBundle(const RSubConParameterBundle &)

RSubConParameterBundle

(

const RSubConParameterBundle &

aBundle

)

[private]

Copy Constructor

Parameters

const RSubConParameterBundle & aBundle

Member Functions Documentation

AddFamilyL(CSubConParameterFamily *)

IMPORT_C void

AddFamilyL

(

CSubConParameterFamily *

aFamily

)

Add a sub-connection parameter family to the bundle.

Note: The RSubConParameterBundle object takes ownership of the parameter family that is passed into this method. When the bundle object is destroyed, any family owned by this object will also be destroyed.

Exceptions

leaves

with KErrNoMemory in out of memory conditions

Parameters

CSubConParameterFamily * aFamily

Family to be added (bundle takes ownership)

CheckBundle()

TInt

CheckBundle

(

)

const [protected]

Check to see if the handle has a heap object. If it hasn't, it creates one

ClearAllParameters(CSubConParameterFamily::TParameterSetType)

IMPORT_C void

ClearAllParameters

(

CSubConParameterFamily::TParameterSetType

aType

)

Clears (removes and deletes) all parameter sets with the type specified (delegated to the families)

Parameters

CSubConParameterFamily::TParameterSetType aType

The type of the set to be deleted(requested, acceptable or granted)

Close()

IMPORT_C void

(

)

Close the parameter bundle handle

CopyFromFamilyBundleL(RParameterFamilyBundle &)

void

CopyFromFamilyBundleL

(

RParameterFamilyBundle &

aSrc

)

Copy the contents of an RParameterFamilyBundle to this RSubConParameterBundle

Parameters

RParameterFamilyBundle & aSrc

RParameterFamilyBundle to copy contents from

CopyToFamilyBundleL(RParameterFamilyBundle &)

void

CopyToFamilyBundleL

(

RParameterFamilyBundle &

aDest

)

const

Copy the contents of this parameter bundle to a RParameterFamilyBundle .

Parameters

RParameterFamilyBundle & aDest

RParameterFamilyBundle to copy parameters to

FindFamily(TUint32)

IMPORT_C CSubConParameterFamily *

FindFamily

(

TUint32

aFamilyId

)

Search the sub-connection parameter bundle for a parameter family

Parameters

TUint32 aFamilyId

Id of the family to match against. It is an identifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

Length()

IMPORT_C TUint

Length

(

)

const

Calculates the length of buffer required to serialise this parameter set bundle.

Load(const TDesC8 &)

IMPORT_C TInt

Load

(

const TDesC8 &

aDes

)

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

Parameters

const TDesC8 & aDes

Buffer containing the serialised bundle object

Store(TDes8 &)

IMPORT_C TInt

Store

(

TDes8 &

aDes

)

const

Instructs this sub-connection parameter bundle to create a serilised version of itself and append it to the buffer that has been passed.

Parameters

TDes8 & aDes

Buffer to append the serialised object to

operator=(const RSubConParameterBundle &)

RSubConParameterBundle &

operator=

(

const RSubConParameterBundle &

aBundle

)

[private]

Assignment operator

Parameters

const RSubConParameterBundle & aBundle

Member Data Documentation

CSubConParameterBundle * iBundle

CSubConParameterBundle *

iBundle

[private]