Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: msvreg.h
Link against: msgs.lib

Class CMtmGroupData

CMtmGroupData

Support

Supported from 5.0

Description

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

In pre-Unicode versions this class had the import library ment.lib.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CMtmGroupDataEncapsulates the registration data for an MTM group

Defined in CMtmGroupData:
ExternalizeL(), InternalizeL(), MtmDllInfoArray(), MtmTypeUid(), NewL(), TechnologyTypeUid(), operator==()

Inherited from CBase:
operator new()


Allocation and initialisation


NewL()

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

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

const CMtmDllInfoArray& aMtmDllInfoArray

Array of registration data for the MTM components in the group

Return value

CMtmGroupData*

New initialised CMtmGroupData

Leave codes

KErrNoMemory

A memory allocation failed


NewL()

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

[Top]


Streaming


ExternalizeL()

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


InternalizeL()

void InternalizeL(RReadStream& aStream);

Description

Internalises group registration data.

Parameters

RReadStream& aStream

Stream from which to internalise object

[Top]


Accessors


MtmDllInfoArray()

const CMtmDllInfoArray& MtmDllInfoArray() const;

Description

Gets an array of registration data for the MTM components in the group.

Return value

CMtmDllInfoArray&

Array of registration data for the MTM components in the group


MtmTypeUid()

TUid MtmTypeUid() const;

Description

Gets the group UID.

Return value

TUid

UID that uniquely identifies the MTM group


TechnologyTypeUid()

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

[Top]


Operators


operator==()

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.