#include <MSVREG.H>
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

Class `CMtmDllInfo`

class CMtmDllInfo : public CBase;

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.

Derivation

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

CMtmDllInfo - Encapsulates the registration data for a single concrete MTM component.

Members

Defined in CMtmDllInfo:

CapabilitiesAvailable()constTests if settings have been made for the CMtmDllInfo::MessagingCapability()const...
ExternalizeL(RWriteStream &)constExternalises the object to a stream.
HumanReadableName()constGets the descriptive name of the MTM component for which the object holds regist...
InternalizeL(RReadStream &)Internalises the object from a stream.
MessagingCapability()constTests if the flag that indicates that the MTM can send messages has been set.
NewL(RReadStream &)Creates a new CMtmDllInfo and initialises it with values read from a stream.
NewL(const CMtmDllInfo &)Creates a new CMtmDllInfo initialised from another CMtmDllInfo object.
NewL(const TDesC &,const TUidType &,const TDesC &,TInt,const TVersion)Creates a new CMtmDllInfo and initialises it with values describing an MTM compo...
SendBodyCapability()constTests if the flag that indicates that the MTM can handle body text has been set.
SetHumanReadableNameL(const TDesC &)Sets the descriptive name of the MTM component for which the object holds regist...
iCapabilitiesAvailableFlag that indicates if settings have been made for the CMtmDllInfo::MessagingCap...
iEntryPointOrdinalNumberOrdinal of factory function for the MTM component
iMessagingCapabilityFlag that indicates if the MTM can send messages
iSendBodyCapabilityFlag that indicates if the MTM can handle body text
iUidTypeGroup of UIDs for the MTM. See CMtmDllInfo::NewL(const TDesC &,const TUidTyp...
iVersionVersion information for the MTM component
operator==(const CMtmDllInfo &)constOverloaded equality operator.
~CMtmDllInfo()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...

Construction and destruction

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

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

Description

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

Parameters

`const TDesC16 &aHumanReadableName`	Descriptor holding a descriptive name for the MTM component
`const TUidType &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
`const TDesC16 &aFilename`	A full filename (including drive and path) of the MTM dll
`TInt aEntryPointOrdinalNumber`	Ordinal of factory function for the MTM
`const TVersion aVersion`	Version information for the MTM component

Return value

CMtmDllInfo *

New CMtmDllInfo initialised with passed values

Leave codes

KErrNoMemory

A memory allocation failed

`NewL(const CMtmDllInfo &)`

IMPORT_C static CMtmDllInfo* NewL(const CMtmDllInfo &aMtmDllInfo);

Description

Creates a new CMtmDllInfo initialised from another CMtmDllInfo object.

Parameters

const CMtmDllInfo &aMtmDllInfo

A CMtmDllInfo object from which to initialise this

Return value

CMtmDllInfo *

New CMtmDllInfo initialised with passed CMtmDllInfo

Leave codes

KErrNoMemory

A memory allocation failed

`NewL(RReadStream &)`

IMPORT_C static CMtmDllInfo* NewL(RReadStream &aStream);

Description

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(RWriteStream &)const.

Parameters


                                 						RReadStream &aStream

Stream to read from

Return value

CMtmDllInfo *

New CMtmDllInfo

Leave codes

KErrNoMemory

A memory allocation failed

`~CMtmDllInfo()`

IMPORT_C ~CMtmDllInfo();

Description

Destructor.

Member functions

`SetHumanReadableNameL(const TDesC &)`

IMPORT_C void SetHumanReadableNameL(const TDesC &aHumanReadableName);

Description

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

Parameters

const TDesC16 &aHumanReadableName

Descriptor holding a descriptive name for the MTM component

`HumanReadableName()const`

inline TPtrC HumanReadableName() const;

Description

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

Return value


                                 						TPtrC16

Descriptor holding the descriptive name of the MTM component

`InternalizeL(RReadStream &)`

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the object from a stream.

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

Parameters


                                 						RReadStream &aStream

Stream to read from

Leave codes

Error

Standard streaming errors

`ExternalizeL(RWriteStream &)const`

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the object to a stream.

Parameters


                                 						RWriteStream &aStream

Stream to write to

Leave codes

Error

Standard streaming errors

`operator==(const CMtmDllInfo &)const`

IMPORT_C TBool operator==(const CMtmDllInfo &aMtmDllInfo) const;

Description

Overloaded equality operator.

Parameters

const CMtmDllInfo &aMtmDllInfo

Object to compare

Return value

TBool

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

`MessagingCapability()const`

IMPORT_C TBool MessagingCapability() const;

Description

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

Return value

TBool

True if the flag has been set; otherwise false

`SendBodyCapability()const`

IMPORT_C TBool SendBodyCapability() const;

Description

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

Return value

TBool

True if the flag has been set; otherwise false

`CapabilitiesAvailable()const`

IMPORT_C TBool CapabilitiesAvailable() const;

Description

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

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

Return value

TBool

True if the settings exist; otherwise false

Member data

`iUidType`

TUidType iUidType;

Description

Group of UIDs for the MTM. See CMtmDllInfo::NewL(const TDesC &,const TUidType &,const TDesC &,TInt,const TVersion) for details.

`iEntryPointOrdinalNumber`

TInt iEntryPointOrdinalNumber;

Description

Ordinal of factory function for the MTM component

`iVersion`

TVersion iVersion;

Description

Version information for the MTM component

`iMessagingCapability`

TBool iMessagingCapability;

Description

Flag that indicates if the MTM can send messages

`iSendBodyCapability`

TBool iSendBodyCapability;

Description

Flag that indicates if the MTM can handle body text

`iCapabilitiesAvailable`

TBool iCapabilitiesAvailable;

Description

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

Class CMtmDllInfo

Description

Derivation

Members

Construction and destruction

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

Description

Parameters

Return value

Leave codes

NewL(const CMtmDllInfo &)

Description

Parameters

Return value

Leave codes

NewL(RReadStream &)

Description

Parameters

Return value

Leave codes

~CMtmDllInfo()

Description

Member functions

SetHumanReadableNameL(const TDesC &)

Description

Parameters

HumanReadableName()const

Description

Return value

InternalizeL(RReadStream &)

Description

Parameters

Leave codes

ExternalizeL(RWriteStream &)const

Description

Parameters

Leave codes

operator==(const CMtmDllInfo &)const

Description

Parameters

Return value

MessagingCapability()const

Description

Return value

SendBodyCapability()const

Description

Return value

CapabilitiesAvailable()const

Description

Return value

Member data

iUidType

Description

iEntryPointOrdinalNumber

Description

iVersion

Description

iMessagingCapability

Description

iSendBodyCapability

Description

iCapabilitiesAvailable

Description

Class `CMtmDllInfo`

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

`NewL(const CMtmDllInfo &)`

`NewL(RReadStream &)`

`~CMtmDllInfo()`

`SetHumanReadableNameL(const TDesC &)`

`HumanReadableName()const`

`InternalizeL(RReadStream &)`

`ExternalizeL(RWriteStream &)const`

`operator==(const CMtmDllInfo &)const`

`MessagingCapability()const`

`SendBodyCapability()const`

`CapabilitiesAvailable()const`

`iUidType`

`iEntryPointOrdinalNumber`

`iVersion`

`iMessagingCapability`

`iSendBodyCapability`

`iCapabilitiesAvailable`