Class CMtmGroupData

class CMtmGroupData : public CBase;

Description

Encapsulates the registration data for an MTM group.

It is used to access and write the registration data file for an MTM group.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMtmGroupData - Encapsulates the registration data for an MTM group.

Members

Defined in CMtmGroupData:

• ExternalizeL(RWriteStream &)constExternalises group registration data.
• GetMtmRequiredCapabilities()const
• InternalizeL(RReadStream &)Internalises group registration data.
• MtmDllInfoArray()constReturns a constant reference to the array of MTM dll information objects owned b...
• MtmTypeUid()constGets the group UID.
• NewL(RReadStream &)Creates a new CMtmGroupData and initialises it from the specified stream.
• NewL(TUid,TUid,CMtmDllInfoArray *,const TCapabilitySet &)Creates a new CMtmGroupData and initialise it with registration data for an MTM ...
• NewL(const CMtmGroupData &)Creates a new CMtmGroupData and initialises it with another CMtmGroupData
• TechnologyTypeUid()constGets the technology UID.
• operator==(const CMtmGroupData &)constTests for equality with another CMtmGroupData object.
• ~CMtmGroupData()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CMtmGroupData* NewL(TUid aMtmTypeUid, TUid aTechnologyTypeUid, CMtmDllInfoArray *aMtmDllInfoArray, const TCapabilitySet &aMtmRequiredCaps);

Description

Creates a new CMtmGroupData and initialise it with registration data for an MTM group.

Parameters

TUid aMtmTypeUid UID that uniquely identifies the MTM group TUid aTechnologyTypeUid UID that can be used to indicate the messaging technology which the MTM group implements CMtmDllInfoArray *aMtmDllInfoArray Array of registration data for the MTM components in the group. This function takes immediate responsibility for aMtmDllInfoArray, so it should not be on the cleanup stack prior to the call. If successful, the newly created CMtmGroupData takes ownership of the object const TCapabilitySet &aMtmRequiredCaps The required security capabilities for this MTM group

Return value

CMtmGroupData * New initialised CMtmGroupData

Leave codes

KErrNoMemory A memory allocation failed

IMPORT_C static CMtmGroupData* NewL(const CMtmGroupData &aMtmGroupData);

Description

Creates a new CMtmGroupData and initialises it with another CMtmGroupData

Parameters

const CMtmGroupData &aMtmGroupData

Return value

CMtmGroupData * New initialised CMtmGroupData

Leave codes

KErrNoMemory A memory allocation failed

IMPORT_C static CMtmGroupData* NewL(RReadStream &aStream);

Description

Creates a new CMtmGroupData and initialises it from the specified stream.

Parameters

RReadStream &aStream Stream from which to read previously externalised CMtmGroupData

Return value

CMtmGroupData * New initialised CMtmGroupData

Leave codes

KErrNoMemory A memory allocation failed

IMPORT_C ~CMtmGroupData();

Description

Destructor.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises group registration data.

Parameters

RReadStream &aStream Stream from which to internalise object

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises group registration data.

This is the method by which registration data is written to a MTM registration data file.

Parameters

RWriteStream &aStream Stream to which to externalise object

inline TUid MtmTypeUid() const;

Description

Gets the group UID.

Return value

TUid UID that uniquely identifies the MTM group

inline TUid TechnologyTypeUid() const;

Description

Gets the technology UID.

Technology types can be used to conceptually group different MTMs (e.g. as providing Internet email).

Return value

TUid UID that indicates the messaging technology that the MTM group implements

IMPORT_C const CMtmDllInfoArray& MtmDllInfoArray() const;

Description

Returns a constant reference to the array of MTM dll information objects owned by the CMtmGroupData.

Return value

const CMtmDllInfoArray & A constant reference to the MTM dll info array

IMPORT_C const TCapabilitySet& GetMtmRequiredCapabilities() const;

Description

Return value

const TCapabilitySet &

IMPORT_C TBool operator==(const CMtmGroupData &aMtmGroupData) const;

Description

Tests for equality with another CMtmGroupData object.

Parameters

const CMtmGroupData &aMtmGroupData CMtmGroupData object with which to compare

Return value

TBool ETrue: equal, EFalse: unequal.