CMtmDllRegistry Class Reference

#include <mw/msvreg.h>

Link against: msgs_autoshutdown.lib

class CMtmDllRegistry : public CBase, public CBase, public CBase

Inherits from

Protected Attributes
RFs &iFs
TUid iMtmDllTypeUid
CRegisteredMtmDllArray iRegisteredMtmDllArray
TTimeIntervalMicroSeconds32 iTimeoutMicroSeconds32
Public Member Functions
~CMtmDllRegistry()
IMPORT_C TBoolIsInUse(TUid)
IMPORT_C TBoolIsInUse()
TBool IsPresent(TUid)
IMPORT_C TUidMtmTypeUid(TInt)
TInt NumRegisteredMtmDlls()
IMPORT_C const CMtmDllInfo &RegisteredMtmDllInfo(TUid)
IMPORT_C TUidTechnologyTypeUid(TUid)
Protected Member Functions
CMtmDllRegistry(RFs &, TUid, TTimeIntervalMicroSeconds32)
IMPORT_C TIntAddRegisteredMtmDll(TUid, TUid, const CMtmDllInfo &, MRegisteredMtmDllObserver &)
IMPORT_C TIntMtmTypeUidToIndex(TUid)
IMPORT_C voidRemoveAllRegisteredMtmDlls()
IMPORT_C voidRemoveRegisteredMtmDll(TUid)
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

Accesses the various MTM component registries.

The derived classes used by clients are CClientMtmRegistry, CMtmUiDataRegistry, and CMtmUiRegistry. It provides functions to discover the MTMs registered in such a registry. The registered MTMs can be regarded as existing in a list: you can use NumRegisteredMtmDlls() to get the number in the list, and MtmTypeUid() to index into it.

Member Attribute Documentation

iFs

RFs &iFs[protected]

iMtmDllTypeUid

TUid iMtmDllTypeUid[protected]

iRegisteredMtmDllArray

CRegisteredMtmDllArray iRegisteredMtmDllArray[protected]

iTimeoutMicroSeconds32

TTimeIntervalMicroSeconds32 iTimeoutMicroSeconds32[protected]

Constructor & Destructor Documentation

CMtmDllRegistry ( RFs &, TUid, TTimeIntervalMicroSeconds32 )

IMPORT_CCMtmDllRegistry(RFs &aFs,
TUidaMtmDllTypeUid,
TTimeIntervalMicroSeconds32aTimeoutMicroSeconds32 = 30000000
)[protected]

~CMtmDllRegistry ( )

IMPORT_C~CMtmDllRegistry()

Member Function Documentation

AddRegisteredMtmDll ( TUid, TUid, const CMtmDllInfo &, MRegisteredMtmDllObserver & )

IMPORT_C TIntAddRegisteredMtmDll(TUidaMtmTypeUid,
TUidaTechnologyTypeUid,
const CMtmDllInfo &aMtmDllInfo,
MRegisteredMtmDllObserver &aRegisteredMtmDllObserver
)[protected]

IsInUse ( TUid )

IMPORT_C TBoolIsInUse(TUidaMtmTypeUid)const

Tests if the MTM with the specified UID is in use. You should check that the MTM is registered, through IsPresent(), before calling this function.

Parameters
aMtmTypeUidUID of MTM to check
Return Value
ETrue if the specified MTM in use, else EFalse

IsInUse ( )

IMPORT_C TBoolIsInUse()const

Tests if any registered MTM is in use.

Return Value
ETrue if any MTM in use, else EFalse

IsPresent ( TUid )

TBool IsPresent(TUidaMtmTypeUid)const [inline]

Tests if the MTM with the specified UID is registered.

Parameters
aMtmTypeUidUID of MTM to check
Return Value
ETrue if the specified MTM in registered, else EFalse

MtmTypeUid ( TInt )

IMPORT_C TUidMtmTypeUid(TIntanIndex)const

Gets the MTM UID of a registered MTM using its index.

Parameters
anIndexIndexed of registered MTM
Return Value
MTM UID

MtmTypeUidToIndex ( TUid )

IMPORT_C TIntMtmTypeUidToIndex(TUidanMtmTypeUid)const [protected]

NumRegisteredMtmDlls ( )

TInt NumRegisteredMtmDlls()const [inline]

RegisteredMtmDllInfo ( TUid )

IMPORT_C const CMtmDllInfo &RegisteredMtmDllInfo(TUidaMtmTypeUid)const

Gets the registration data for the specified MTM.

Parameters
aMtmTypeUidUID of MTM
Return Value
Registration data for MTM

RemoveAllRegisteredMtmDlls ( )

IMPORT_C voidRemoveAllRegisteredMtmDlls()[protected]

RemoveRegisteredMtmDll ( TUid )

IMPORT_C voidRemoveRegisteredMtmDll(TUidaMtmTypeUid)[protected]

TechnologyTypeUid ( TUid )

IMPORT_C TUidTechnologyTypeUid(TUidaMtmTypeUid)const

Gets the technology type UID for the specified MTM.

Parameters
aMtmTypeUidUID of MTM
Return Value
Technology type UID
© Nokia 2005.