#include <mw/mtuireg.h>
Link against: mtur.lib
class CMtmUiRegistry : public CObserverRegistry, public CObserverRegistry |
Public Member Functions | |
---|---|
virtual | ~CMtmUiRegistry() |
IMPORT_C CMtmUiRegistry * | NewL(CMsvSession &, TTimeIntervalMicroSeconds32) |
IMPORT_C CBaseMtmUi * | NewMtmUiL(CBaseMtm &) |
Protected Member Functions | |
---|---|
CMtmUiRegistry(CMsvSession &, TTimeIntervalMicroSeconds32) |
Inherited Enumerations | |
---|---|
MMsvSessionObserver:TMsvSessionEvent |
Accesses the User Interface MTM registry.
This registry holds details of the all the User Interface MTMs currently available on the system. Message client applications use this class to get a CBaseMtmUi-derived object by which to access User Interface MTM functionality.
Note that the base class CMtmDllRegistry provides functions for discovering what MTMs are present in the registry.
CMtmUiRegistry | ( | CMsvSession & | aMsvSession, |
TTimeIntervalMicroSeconds32 | aTimeoutMicroSeconds32 | ||
) | [protected] |
IMPORT_C CMtmUiRegistry * | NewL | ( | CMsvSession & | aMsvSession, |
TTimeIntervalMicroSeconds32 | aTimeoutMicroSeconds32 = TTimeIntervalMicroSeconds32(30000000) | |||
) | [static] |
Constructs and allocates a CMtmUiRegistry object.
The client should delete this object when it is no longer required.
The registry keeps a reference count of the number of instances of each MTM in use. When that reference count falls to zero, the DLL that provides the MTM is unloaded. However, this is not done immediately, but only after the time specified in aTimeoutMicroSeconds32. This increases efficiency in cases where the DLL is required again shortly.
Parameters | |
---|---|
aMsvSession | The client's Message Server session |
aTimeoutMicroSeconds32 | Time to wait before unloading MTM DLLs |
Leave Codes | |
---|---|
KErrNoMemory | A memory allocation failed |
IMPORT_C CBaseMtmUi * | NewMtmUiL | ( | CBaseMtm & | aMtm | ) |
Creates a User Interface MTM object for the specified MTM.
The client should delete the returned object when it is no longer required.
Parameters | |
---|---|
aMtm | Client MTM for which to get the associated UI MTM |
Leave Codes | |
---|---|
KErrNotFound | MTM type could not be found |
KErrNoMemory | A memory allocation failed |
KErrBadLibraryEntryPoint | Malformed MTM: a library entry point was not of the required type |
Other | DLL loading error codes if the DLL that provides the MTM cannot be loaded |