EPOC   SDK Home Glossary Indexes Previous Next Up

CMtmGroupData class


Contents


CMtmGroupData class — MTM group registry information

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behaviour

Defined in

msvreg.h

Link against

ment.lib

Description

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


Allocation and initialisation


NewL() — Allocate and initialise

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

Description

Use this function to create a new CMtmGroupData and initialise it with registration data for an MTM group.

Arguments

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 considerations

KErrNoMemory

A memory allocation failed


NewL() — Allocation and initialise from stream store

static CMtmGroupData* NewL(RReadStream& aStream);

Description

Use this function to create a new CMtmGroupData and initialise it from the stream indicated by aStream.

Arguments

RReadStream& aStream

Stream from which to read previously externalised CMtmGroupData

Return value

CMtmGroupData*

New initialised CMtmGroupData

Leave considerations

KErrNoMemory

A memory allocation failed


Streaming


ExternalizeL() — Externalise group registration data

void ExternalizeL(RWriteStream& aStream) const;

Description

Use this function to externalise group registration data. This is the method by which registration data is written to a MTM registration data file.

Arguments

RWriteStream& aStream

Stream to which to externalise object


InternalizeL() — Internalise group registration data

void InternalizeL(RReadStream& aStream);

Description

Use this function to internalise group registration data.

Arguments

RReadStream& aStream

Stream from which to internalise object


Accessors


MtmDllInfoArray() — Get component registration data

const CMtmDllInfoArray& MtmDllInfoArray() const;

Description

Use this function to get 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() — Get group UID

TUid MtmTypeUid() const;

Description

Use this function to get the group UID.

Return value

TUid

UID that uniquely identifies the MTM group


TechnologyTypeUid() — Get technology UID

TUid TechnologyTypeUid() const;

Description

Use this function to get the technology UID.

Return value

TUid

UID that indicates the messaging technology that the MTM group implements


Operators


operator==() — Equality operator

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

Description

Use this operator to test for equality with another CMtmGroupData object.

Arguments

const CMtmGroupData& aMtmGroupData

CMtmGroupData object with which to compare

Return value

TBool

ETrue: equal

EFalse: unequal.

EPOC       SDK Home Glossary Indexes Previous Next Up