CMtmDllInfo Class Reference

#include <mw/msvreg.h>

Link against: msgs_autoshutdown.lib

class CMtmDllInfo : public CBase, public CBase, public CBase

Inherits from

CMtmDllInfo

Public Attributes
TBool	iCapabilitiesAvailable
TInt	iEntryPointOrdinalNumber
TBool	iMessagingCapability
TBool	iSendBodyCapability
TUidType	iUidType
TVersion	iVersion

Public Member Functions
	~CMtmDllInfo()
IMPORT_C TBool	CapabilitiesAvailable()
IMPORT_C void	ExternalizeL(RWriteStream &)
TPtrC	FileName()
TPtrC	HumanReadableName()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TBool	MessagingCapability()
IMPORT_C CMtmDllInfo *	NewL(const TDesC &, const TUidType &, const TDesC &, TInt, const TVersion)
IMPORT_C CMtmDllInfo *	NewL(const CMtmDllInfo &)
IMPORT_C CMtmDllInfo *	NewL(RReadStream &)
IMPORT_C TBool	SendBodyCapability()
void	SetCapabilitiesAvailable(TBool)
IMPORT_C void	SetHumanReadableNameL(const TDesC &)
void	SetMessagingCapability(TBool)
void	SetSendBodyCapability(TBool)
IMPORT_C TBool	operator==(const CMtmDllInfo &)

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 a single concrete MTM component.

It is used in the creation of registration data for an MTM group. Typically, an application gathers a number of CMtmDllInfo objects into an CMtmDllInfoArray.

Member Attribute Documentation

iCapabilitiesAvailable

TBool

iCapabilitiesAvailable

Flag that indicates if settings have been made for the MessagingCapability() and SendBodyCapability() flags

iEntryPointOrdinalNumber

TInt	iEntryPointOrdinalNumber

Ordinal of factory function for the MTM component

iMessagingCapability

TBool

iMessagingCapability

Flag that indicates if the MTM can send messages

iSendBodyCapability

TBool

iSendBodyCapability

Flag that indicates if the MTM can handle body text

iUidType

TUidType

iUidType

Group of UIDs for the MTM. See NewL() for details.

iVersion

TVersion

iVersion

Version information for the MTM component

Constructor & Destructor Documentation

~CMtmDllInfo ( )

IMPORT_C

~CMtmDllInfo

(

)

Destructor.

Member Function Documentation

CapabilitiesAvailable ( )

IMPORT_C TBool

CapabilitiesAvailable

(

)

const

Tests if settings have been made for the MessagingCapability() and SendBodyCapability() flags.

These settings are optional, so may not have been made for all MTMs.

Return Value: True if the settings exist; otherwise false

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises the object to a stream.

Parameters
aStream	Stream to write to

Leave Codes
Error	Standard streaming errors

FileName ( )

TPtrC

FileName

(

)

const

HumanReadableName ( )

TPtrC

HumanReadableName

(

)

const [inline]

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises the object from a stream.

The contents of the stream to read will have been created by CMtmDllInfo::ExternalizeL().

Parameters
aStream	Stream to read from

Leave Codes
Error	Standard streaming errors

MessagingCapability ( )

IMPORT_C TBool

MessagingCapability

(

)

const

Tests if the flag that indicates that the MTM can send messages has been set.

Return Value: True if the flag has been set; otherwise false

NewL ( const TDesC &, const TUidType &, const TDesC &, TInt, const TVersion )

IMPORT_C CMtmDllInfo *	NewL	(	const TDesC &	aHumanReadableName,
			const TUidType &	aUidType,
			const TDesC &	aFilename,
			TInt	aEntryPointOrdinalNumber,
			const TVersion	aVersion
		)	[static]

Creates a new CMtmDllInfo and initialises it with values describing an MTM component.

Parameters
aHumanReadableName	Descriptor holding a descriptive name for the MTM component
aUidType	Group of UIDs for the MTM. The UIDs should be as follows: UID1: always KDynamicLibraryUid UID2: identifies whether the MTM component is a Client-side MTM, User Interface MTM, UI Data MTM, or Server-side MTM. UID3: identifies this concrete MTM uniquely
aFilename	A full filename (including drive and path) of the MTM dll
aEntryPointOrdinalNumber	Ordinal of factory function for the MTM
aVersion	Version information for the MTM component

Return Value: New CMtmDllInfo initialised with passed values

Leave Codes
KErrNoMemory	A memory allocation failed

NewL ( const CMtmDllInfo & )

IMPORT_C CMtmDllInfo *

NewL

(

const CMtmDllInfo &

aMtmDllInfo

)

[static]

Creates a new CMtmDllInfo initialised from another CMtmDllInfo object.

Parameters
aMtmDllInfo	A CMtmDllInfo object from which to initialise this

Return Value: New CMtmDllInfo initialised with passed CMtmDllInfo

Leave Codes
KErrNoMemory	A memory allocation failed

NewL ( RReadStream & )

IMPORT_C CMtmDllInfo *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new CMtmDllInfo and initialises it with values read from a stream.

The contents of the stream to read will have been created by CMtmDllInfo::ExternalizeL().

Parameters
aStream	Stream to read from

Return Value: New CMtmDllInfo

Leave Codes
KErrNoMemory	A memory allocation failed

SendBodyCapability ( )

IMPORT_C TBool

SendBodyCapability

(

)

const

Tests if the flag that indicates that the MTM can handle body text has been set.

Return Value: True if the flag has been set; otherwise false

SetCapabilitiesAvailable ( TBool )

void

SetCapabilitiesAvailable

(

TBool

aBool

)

Sets a flag to indicate that settings have been made for the MessagingCapability() and SendBodyCapability() flags.

These settings are optional, so may not have been made for all MTMs.

Parameters
aBool	True if the settings exist; otherwise false

SetHumanReadableNameL ( const TDesC & )

IMPORT_C void

SetHumanReadableNameL

(

const TDesC &

aHumanReadableName

)

Sets the descriptive name of the MTM component for which the object holds registration data.

Parameters
aHumanReadableName	Descriptor holding a descriptive name for the MTM component

SetMessagingCapability ( TBool )

void

SetMessagingCapability

(

TBool

aCapability

)

Sets a flag to indicate that the MTM can send messages.

Parameters
aCapability	True to set the flag, false to clear it

SetSendBodyCapability ( TBool )

void

SetSendBodyCapability

(

TBool

aCapability

)

Sets a flag to indicate that the MTM can handle body text.

Parameters
aCapability	True to set the flag, false to clear it

operator== ( const CMtmDllInfo & )

IMPORT_C TBool

operator==

(

const CMtmDllInfo &

aMtmDllInfo

)

const

Overloaded equality operator.

Parameters
aMtmDllInfo	Object to compare

Return Value: True if the iFileName member and the UIDs (iUidType member) are the same in both objects, otherwise false