Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: cs_subconevents.h
Link against: subconparams.lib

Class CSubConGenEventParamsGranted

class CSubConGenEventParamsGranted : public CSubConNotificationEvent;

Description

Subconnection parameters granted event.

Provides an interface for granted parameters event. This event will contain a negotiated generic parameter set and zero or more negotiated extension parameter sets.

Notification of this event occurs after a request to RSubConnection::SetParameters() has been made and negotiation with the network has been completed. A notification will be received for each family contained in the parameter bundle that was negotiated successfully. This event presents a generic set and zero or more extension sets (providing they are supported by the underlying sub-connection provider technology) of the parameter family identified by the Id return from GetFamily().

The following operations are also provided:

GetGenericSet()/SetGenericSet() - Accessor function for Generic Parameter Sets. GetExtensionSet() - Get extension parameter set of a particular index. AddExtensionSetL() - Add extension parameter set. GetFamily()/SetFamily() - Accessor function for parameter family type.

Derivation

Members

Defined in CSubConGenEventParamsGranted:
AddExtensionSetL(), CSubConGenEventParamsGranted(), GetAttribPtr(), GetExtensionSet(), GetFamily(), GetGenericSet(), GetNumExtensionSets(), GetVDataTable(), NewL(), SetFamily(), SetGenericSet(), iExtensionSets, iFamily, iGenericSet, iVDataTable, ~CSubConGenEventParamsGranted()

Inherited from CSubConNotificationEvent:
GroupId(), Id(), IsGeneric()


Construction and destruction


NewL()

static inline CSubConGenEventParamsGranted *NewL();

Description

Creates a granted parameter event sub-connection.

Return value

CSubConGenEventParamsGranted *

a CSubConGenEventParamsGranted object pointer if successful, otherwise leaves with system error code.


CSubConGenEventParamsGranted()

inline CSubConGenEventParamsGranted();

Description

Empty CSubConGenEventParamsGranted constructor


~CSubConGenEventParamsGranted()

virtual ~CSubConGenEventParamsGranted();

Description

(virtual) sub-connection parameter granted event destructor

[Top]


Member functions


GetGenericSet()

inline const CSubConGenericParameterSet *const GetGenericSet() const;

Description

Gets Generic Parameter set.

Return value

const CSubConGenericParameterSet *const

pointer to CSubConGenericParameterSet.


SetGenericSet()

inline void SetGenericSet(CSubConGenericParameterSet *aGenericSet);

Description

Sets Generic Parameter set.

Parameters

CSubConGenericParameterSet *aGenericSet

pointer to Generic Parameter set.


GetExtensionSet()

inline const CSubConExtensionParameterSet *const GetExtensionSet(TUint aIndex) const;

Description

Gets Extension Parameter set.

Parameters

TUint aIndex

the index number of the extension parameter to be returned (index number must not be greater than the value returned by CSubConGenEventParamsGranted::GetNumExtensionSets())

Return value

const CSubConExtensionParameterSet *const

pointer to selected CSubConExtensionParameterSet.


AddExtensionSetL()

inline void AddExtensionSetL(CSubConExtensionParameterSet *aExtensionSet);

Description

Adds Extension Parameter set.

Parameters

CSubConExtensionParameterSet *aExtensionSet

extension parameter set to be added in the list.


GetNumExtensionSets()

inline TInt GetNumExtensionSets();

Description

Gets the number of Extension Parameter set.

Return value

TInt

number of Extension Parameter set.


GetFamily()

inline TUint32 GetFamily() const;

Description

Gets parameter family type.

Return value

TUint32

parameter family type.


SetFamily()

inline void SetFamily(TUint32 aFamily);

Description

Sets parameter family type.

Parameters

TUint32 aFamily

parameter family type.


GetVDataTable()

protected: virtual Meta::SVDataTableEntry const *GetVDataTable() const;

Description

Return value

Meta::SVDataTableEntry const *


GetAttribPtr()

protected: virtual TUint8 *GetAttribPtr(const TInt aOffset) const;

Description

Parameters

const TInt aOffset

Return value

TUint8 *

[Top]


Member data


iVDataTable

protected: const Meta::SVDataTableEntry iVDataTable;

Description


iFamily

protected: TUint32 iFamily;

Description


iGenericSet

protected: CSubConGenericParameterSet * iGenericSet;

Description


iExtensionSets

protected: RMetaDataEComContainer iExtensionSets;

Description