CMtmGroupData Class Reference

#include <mw/msvreg.h>

Link against: msgs_autoshutdown.lib

class CMtmGroupData : public CBase, public CBase, public CBase

Inherits from

CMtmGroupData

Public Member Functions
	~CMtmGroupData()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C const TCapabilitySet &	GetMtmRequiredCapabilities()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C const CMtmDllInfoArray &	MtmDllInfoArray()
TUid	MtmTypeUid()
IMPORT_C CMtmGroupData *	NewL(TUid, TUid, CMtmDllInfoArray *, const TCapabilitySet &)
IMPORT_C CMtmGroupData *	NewL(const CMtmGroupData &)
IMPORT_C CMtmGroupData *	NewL(RReadStream &)
TUid	TechnologyTypeUid()
IMPORT_C TBool	operator==(const CMtmGroupData &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Encapsulates the registration data for an MTM group.

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

Constructor & Destructor Documentation

~CMtmGroupData ( )

IMPORT_C

~CMtmGroupData

(

)

Destructor.

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises group registration data.

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

Parameters
aStream	Stream to which to externalise object

GetMtmRequiredCapabilities ( )

IMPORT_C const TCapabilitySet &

GetMtmRequiredCapabilities

(

)

const

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises group registration data.

Parameters
aStream	Stream from which to internalise object

MtmDllInfoArray ( )

IMPORT_C const CMtmDllInfoArray &

MtmDllInfoArray

(

)

const

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

Return Value: A constant reference to the MTM dll info array

MtmTypeUid ( )

TUid

MtmTypeUid

(

)

const [inline]

NewL ( TUid, TUid, CMtmDllInfoArray *, const TCapabilitySet & )

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

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

Parameters
aMtmTypeUid	UID that uniquely identifies the MTM group
aTechnologyTypeUid	UID that can be used to indicate the messaging technology which the MTM group implements
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
aMtmRequiredCaps	The required security capabilities for this MTM group

Return Value: New initialised CMtmGroupData

Leave Codes
KErrNoMemory	A memory allocation failed

NewL ( const CMtmGroupData & )

IMPORT_C CMtmGroupData *

NewL

(

const CMtmGroupData &

aMtmGroupData

)

[static]

Creates a new CMtmGroupData and initialises it with another CMtmGroupData

Return Value: New initialised CMtmGroupData

Leave Codes
KErrNoMemory	A memory allocation failed

NewL ( RReadStream & )

IMPORT_C CMtmGroupData *

NewL

(

RReadStream &

aStream

)

[static]

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

Parameters
aStream	Stream from which to read previously externalised CMtmGroupData

Return Value: New initialised CMtmGroupData

Leave Codes
KErrNoMemory	A memory allocation failed

TechnologyTypeUid ( )

TUid

TechnologyTypeUid

(

)

const [inline]

operator== ( const CMtmGroupData & )

IMPORT_C TBool

operator==

(

const CMtmGroupData &

aMtmGroupData

)

const

Tests for equality with another CMtmGroupData object.

Parameters
aMtmGroupData	CMtmGroupData object with which to compare

Return Value: ETrue: equal, EFalse: unequal.