RSubConParameterBundle Class Reference

#include <es_sock.h>

Link against: esock.lib

class RSubConParameterBundle

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()

Detailed Description

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

Deprecatedsince v9.6

Constructor & Destructor Documentation

RSubConParameterBundle ( )

IMPORT_C

RSubConParameterBundle

(

)

Empty sub-connection parameter bundle constructor

Member Function 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
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

Return Value: KErrNone if successful, otherwise a system wide error

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
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
aSrc	RParameterFamilyBundle to copy contents from

CopyToFamilyBundleL ( RParameterFamilyBundle & )

void

CopyToFamilyBundleL

(

RParameterFamilyBundle &

aDest

)

const

Copy the contents of this parameter bundle to a RParameterFamilyBundle.

Parameters
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
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.

Return Value: Matching family or NULL pointer if not found

Length ( )

IMPORT_C TUint

Length

(

)

const

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

Return Value: Length of buffer required.

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
aDes	Buffer containing the serialised bundle object

Return Value: KErrNone if successful, otherwise system wide error

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
aDes	Buffer to append the serialised object to

Return Value: KErrNone if successful, otherwise system wide error (e.g. EKrrOverflow if the descriptor is too small) If unsuccessful, there is no guarantee as to the buffer or data stored in it.