ATL::CComModule Class Reference

#include <atlbase.h>

Inheritance diagram for ATL::CComModule:

Collaboration diagram for ATL::CComModule:

Public Member Functions
	CComModule ()
	~CComModule ()
HRESULT	Init (_ATL_OBJMAP_ENTRY *p, HINSTANCE, const GUID *plibid)
void	Term ()
HRESULT	GetClassObject (REFCLSID rclsid, REFIID riid, LPVOID *ppv)
HRESULT	RegisterServer (BOOL bRegTypeLib=FALSE, const CLSID *pCLSID=NULL)
HRESULT	UnregisterServer (BOOL bUnRegTypeLib, const CLSID *pCLSID=NULL)
HRESULT	DllCanUnloadNow ()
HRESULT	DllGetClassObject (REFCLSID rclsid, REFIID riid, LPVOID *ppv)
HRESULT	DllRegisterServer (BOOL bRegTypeLib=TRUE)
HRESULT	DllUnregisterServer (BOOL bUnRegTypeLib=TRUE)
Public Member Functions inherited from ATL::CAtlModuleT< CComModule >
HRESULT	RegisterServer (BOOL bRegTypeLib=FALSE, const CLSID *pCLSID=NULL)
HRESULT	UnregisterServer (BOOL bUnRegTypeLib, const CLSID *pCLSID=NULL)
virtual HRESULT	AddCommonRGSReplacements (IRegistrarBase *pRegistrar)
Public Member Functions inherited from ATL::CAtlModule
	CAtlModule ()
virtual LONG	GetLockCount ()
virtual LONG	Lock ()
virtual LONG	Unlock ()
virtual HRESULT	AddCommonRGSReplacements (IRegistrarBase *)=0
HRESULT WINAPI	UpdateRegistryFromResource (LPCTSTR lpszRes, BOOL bRegister, struct _ATL_REGMAP_ENTRY *pMapEntries=NULL)
HRESULT WINAPI	UpdateRegistryFromResource (UINT nResID, BOOL bRegister, struct _ATL_REGMAP_ENTRY *pMapEntries=NULL)

Public Attributes
_ATL_OBJMAP_ENTRY *	m_pObjMap
Public Attributes inherited from ATL::_ATL_MODULE70
UINT	cbSize
LONG	m_nLockCnt
_ATL_TERMFUNC_ELEM *	m_pTermFuncs
CComCriticalSection	m_csStaticDataInitAndTypeInfo

Additional Inherited Members
Static Public Member Functions inherited from ATL::CAtlModuleT< CComModule >
static LPCOLESTR	GetAppId ()
Static Public Attributes inherited from ATL::CAtlModule
static GUID	m_libid

Detailed Description

Definition at line 781 of file atlbase.h.

Constructor & Destructor Documentation

CComModule()

ATL::CComModule::CComModule ( )

inline

Definition at line 786 of file atlbase.h.

    {
        ATLASSERT(_pModule == NULL);
        _pModule = this;
        _pModule->m_pObjMap = NULL;
    }

~CComModule()

ATL::CComModule::~CComModule ( )

inline

Definition at line 793 of file atlbase.h.

    {
        _pModule = NULL;
    }

Member Function Documentation

DllCanUnloadNow()

HRESULT ATL::CComModule::DllCanUnloadNow ( )

inline

Definition at line 929 of file atlbase.h.

    {
        if (GetLockCount() == 0)
            return S_OK;
        return S_FALSE;
    }

Referenced by DllCanUnloadNow().

DllGetClassObject()

HRESULT ATL::CComModule::DllGetClassObject ( REFCLSID  rclsid, REFIID  riid, LPVOID *  ppv  )

inline

Definition at line 936 of file atlbase.h.

    {
        return GetClassObject(rclsid, riid, ppv);
    }

Referenced by DllGetClassObject().

DllRegisterServer()

HRESULT ATL::CComModule::DllRegisterServer ( BOOL  bRegTypeLib = TRUE )

inline

Definition at line 941 of file atlbase.h.

    {
        return RegisterServer(bRegTypeLib);
    }

Referenced by DllRegisterServer().

DllUnregisterServer()

HRESULT ATL::CComModule::DllUnregisterServer ( BOOL  bUnRegTypeLib = TRUE )

inline

Definition at line 946 of file atlbase.h.

    {
        return UnregisterServer(bUnRegTypeLib);
    }

Referenced by DllUnregisterServer().

GetClassObject()

HRESULT ATL::CComModule::GetClassObject ( REFCLSID  rclsid, REFIID  riid, LPVOID *  ppv  )

inline

Definition at line 839 of file atlbase.h.

    {
        _ATL_OBJMAP_ENTRY                    *objectMapEntry;
        HRESULT                                hResult;
 
        ATLASSERT(ppv != NULL);
        if (ppv == NULL)
            return E_POINTER;
        *ppv = NULL;
        hResult = S_OK;
        if (m_pObjMap != NULL)
        {
            objectMapEntry = m_pObjMap;
            while (objectMapEntry->pclsid != NULL)
            {
                if (objectMapEntry->pfnGetClassObject != NULL && InlineIsEqualGUID(rclsid, *objectMapEntry->pclsid) != FALSE)
                {
                    if (objectMapEntry->pCF == NULL)
                    {
                        CComCritSecLock<CComCriticalSection> lock(_AtlComModule.m_csObjMap, true);
 
                        if (objectMapEntry->pCF == NULL)
                            hResult = objectMapEntry->pfnGetClassObject(reinterpret_cast<void *>(objectMapEntry->pfnCreateInstance), IID_IUnknown, reinterpret_cast<LPVOID *>(&objectMapEntry->pCF));
                    }
                    if (objectMapEntry->pCF != NULL)
                        hResult = objectMapEntry->pCF->QueryInterface(riid, ppv);
                    break;
                }
                objectMapEntry++;
            }
        }
        if (hResult == S_OK && *ppv == NULL)
        {
            // FIXME: call AtlComModuleGetClassObject
            hResult = CLASS_E_CLASSNOTAVAILABLE;
        }
        return hResult;
    }

Referenced by DllGetClassObject().

Init()

HRESULT ATL::CComModule::Init ( _ATL_OBJMAP_ENTRY *  p, HINSTANCE  , const GUID *  plibid  )

inline

Definition at line 798 of file atlbase.h.

    {
        _ATL_OBJMAP_ENTRY *objectMapEntry;
 
        if (plibid != NULL)
            m_libid = *plibid;
 
        if (p != reinterpret_cast<_ATL_OBJMAP_ENTRY *>(-1))
        {
            m_pObjMap = p;
            if (p != NULL)
            {
                objectMapEntry = p;
                while (objectMapEntry->pclsid != NULL)
                {
                    objectMapEntry->pfnObjectMain(true);
                    objectMapEntry++;
                }
            }
        }
        return S_OK;
    }

Referenced by DllMain(), if(), CFontExtModule::Init(), InitializeAtlModule(), and wWinMain().

RegisterServer()

HRESULT ATL::CComModule::RegisterServer ( BOOL  bRegTypeLib = FALSE, const CLSID *  pCLSID = NULL  )

inline

Definition at line 878 of file atlbase.h.

    {
        _ATL_OBJMAP_ENTRY *objectMapEntry;
        HRESULT hResult;
 
        hResult = S_OK;
        objectMapEntry = m_pObjMap;
        if (objectMapEntry != NULL)
        {
            while (objectMapEntry->pclsid != NULL)
            {
                if (pCLSID == NULL || IsEqualGUID(*pCLSID, *objectMapEntry->pclsid) != FALSE)
                {
                    hResult = objectMapEntry->pfnUpdateRegistry(TRUE);
                    if (FAILED(hResult))
                        break;
                }
                objectMapEntry++;
            }
        }
        if (SUCCEEDED(hResult))
            hResult = CAtlModuleT<CComModule>::RegisterServer(bRegTypeLib, pCLSID);
        return hResult;
    }

Referenced by DllRegisterServer().

Term()

void ATL::CComModule::Term ( )

inline

Definition at line 821 of file atlbase.h.

    {
        _ATL_OBJMAP_ENTRY                    *objectMapEntry;
 
        if (m_pObjMap != NULL)
        {
            objectMapEntry = m_pObjMap;
            while (objectMapEntry->pclsid != NULL)
            {
                if (objectMapEntry->pCF != NULL)
                    objectMapEntry->pCF->Release();
                objectMapEntry->pCF = NULL;
                objectMapEntry->pfnObjectMain(false);
                objectMapEntry++;
            }
        }
    }

Referenced by DllMain(), InitializeAtlModule(), CFontExtModule::Term(), CShell32Module::Term(), and wWinMain().

UnregisterServer()

HRESULT ATL::CComModule::UnregisterServer ( BOOL  bUnRegTypeLib, const CLSID *  pCLSID = NULL  )

inline

Definition at line 903 of file atlbase.h.

    {
        _ATL_OBJMAP_ENTRY *objectMapEntry;
        HRESULT hResult;
 
        hResult = S_OK;
        objectMapEntry = m_pObjMap;
        if (objectMapEntry != NULL)
        {
            while (objectMapEntry->pclsid != NULL)
            {
                if (pCLSID == NULL || IsEqualGUID(*pCLSID, *objectMapEntry->pclsid) != FALSE)
                {
                    hResult = objectMapEntry->pfnUpdateRegistry(FALSE); //unregister
                    if (FAILED(hResult))
                        break;
                }
                objectMapEntry++;
            }
        }
        if (SUCCEEDED(hResult))
            hResult = CAtlModuleT<CComModule>::UnregisterServer(bUnRegTypeLib, pCLSID);
 
        return hResult;
    }

Referenced by DllUnregisterServer().

Member Data Documentation

m_pObjMap

_ATL_OBJMAP_ENTRY* ATL::CComModule::m_pObjMap

Definition at line 784 of file atlbase.h.

Referenced by CComModule(), GetClassObject(), Init(), RegisterServer(), Term(), and UnregisterServer().

---

The documentation for this class was generated from the following file:

• sdk/lib/atl/atlbase.h