Class RSubConParameterBundle

class RSubConParameterBundle;

Description

Container for (bundle of) SubConnection parameter families.

May contain and 0..N SubConnection parameter families.

Members

Defined in RSubConParameterBundle:
AddFamilyL(), ClearAllParameters(), Close(), FindFamily(), Length(), Load(), RSubConParameterBundle(), Store()

IMPORT_C RSubConParameterBundle();

Description

Empty sub-connection parameter bundle constructor

IMPORT_C void Close();

Description

Close the parameter bundle handle

IMPORT_C TUint Length() const;

Description

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

Return value

TUint Length of buffer required.

IMPORT_C TInt Load(const TDesC8 &aDes);

Description

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

Return value

TInt KErrNone if successful, otherwise system wide error

IMPORT_C TInt Store(TDes8 &aDes) const;

Description

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

Return value

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

IMPORT_C void AddFamilyL(CSubConParameterFamily *aFamily);

Description

Add a sub-connection parameter family to the bundle.

Parameters

CSubConParameterFamily *aFamily Family to be added (bundle takes ownership)

Leave codes

leaves with KErrNoMemory in out of memory conditions

IMPORT_C CSubConParameterFamily *FindFamily(TUint32 aFamilyId);

Description

Search the sub-connection parameter bundle for a parameter family

Parameters

TUint32 aFamilyId Id of the family to match against

Return value

CSubConParameterFamily * Matching family or NULL pointer if not found

IMPORT_C void ClearAllParameters(CSubConParameterFamily::TParameterSetType aType);

Description

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)