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(), ExternalizeL(), HumanReadableName(), InternalizeL(), MessagingCapability(), NewL(), NewL(), NewL(), SendBodyCapability(), SetHumanReadableNameL(), iCapabilitiesAvailable, iEntryPointOrdinalNumber, iMessagingCapability, iSendBodyCapability, iUidType, iVersion, operator==(), ~CMtmDllInfo()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C 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 TDesC &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 TDesC &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

static IMPORT_C 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

static IMPORT_C 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().

Parameters

RReadStream &aStream Stream to read from

Return value

CMtmDllInfo * New CMtmDllInfo

Leave codes

KErrNoMemory A memory allocation failed

IMPORT_C ~CMtmDllInfo();

Description

Destructor.

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 TDesC &aHumanReadableName Descriptor holding a descriptive name for the MTM component

inline TPtrC HumanReadableName() const;

Description

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

Return value

TPtrC Descriptor holding the descriptive name of the MTM component

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().

Parameters

RReadStream &aStream Stream to read from

Leave codes

Error Standard streaming errors

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

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

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

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

IMPORT_C TBool CapabilitiesAvailable() const;

Description

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

TBool True if the settings exist; otherwise false

TUidType iUidType;

Description

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

TInt iEntryPointOrdinalNumber;

Description

Ordinal of factory function for the MTM component

TVersion iVersion;

Description

Version information for the MTM component

TBool iMessagingCapability;

Description

Flag that indicates if the MTM can send messages

TBool iSendBodyCapability;

Description

Flag that indicates if the MTM can handle body text

TBool iCapabilitiesAvailable;

Description

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