ATL::CAtlModule Class Reference

#include <atlbase.h>

Inheritance diagram for ATL::CAtlModule:

Collaboration diagram for ATL::CAtlModule:

Public Member Functions
	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)

Static Public Attributes
static GUID	m_libid

Private Member Functions
HRESULT	CommonInitRegistrar (CRegObject &registrar, WCHAR *modulePath, DWORD modulePathCount, struct _ATL_REGMAP_ENTRY *pMapEntries)

Additional Inherited Members
Public Attributes inherited from ATL::_ATL_MODULE70
UINT	cbSize
LONG	m_nLockCnt
_ATL_TERMFUNC_ELEM *	m_pTermFuncs
CComCriticalSection	m_csStaticDataInitAndTypeInfo

Detailed Description

Definition at line 459 of file atlbase.h.

Constructor & Destructor Documentation

CAtlModule()

ATL::CAtlModule::CAtlModule ( )

inline

Definition at line 464 of file atlbase.h.

    {
        ATLASSERT(_pAtlModule == NULL);
        _pAtlModule = this;
        cbSize = sizeof(_ATL_MODULE);
        m_nLockCnt = 0;
    }

Member Function Documentation

AddCommonRGSReplacements()

virtual HRESULT ATL::CAtlModule::AddCommonRGSReplacements ( IRegistrarBase *  )

pure virtual

Implemented in ATL::CAtlModuleT< T >, ATL::CAtlModuleT< CComModule >, ATL::CAtlModuleT< CAtlObjMapModule >, and ATL::CAtlModuleT< CCleanMgrModule >.

Referenced by CommonInitRegistrar().

CommonInitRegistrar()

HRESULT ATL::CAtlModule::CommonInitRegistrar ( CRegObject &  registrar, WCHAR *  modulePath, DWORD  modulePathCount, struct _ATL_REGMAP_ENTRY *  pMapEntries  )

inlineprivate

Definition at line 534 of file atlbase.h.

    {
        HINSTANCE hInstance;
        DWORD dwFLen;
        HRESULT hResult;
 
        hInstance = _AtlBaseModule.GetModuleInstance();
        dwFLen = GetModuleFileNameW(hInstance, modulePath, modulePathCount);
        if (dwFLen == modulePathCount)
            return HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER);
        else if (dwFLen == 0)
            return HRESULT_FROM_WIN32(GetLastError());
 
        if (pMapEntries != NULL)
        {
            while (pMapEntries->szKey != NULL)
            {
                ATLASSERT(pMapEntries->szData != NULL);
                hResult = registrar.AddReplacement(pMapEntries->szKey, pMapEntries->szData);
                if (FAILED(hResult))
                    return hResult;
                pMapEntries++;
            }
        }
 
        hResult = AddCommonRGSReplacements(&registrar);
        if (FAILED(hResult))
            return hResult;
 
        hResult = registrar.AddReplacement(L"Module", modulePath);
        if (FAILED(hResult))
            return hResult;
 
        hResult = registrar.AddReplacement(L"Module_Raw", modulePath);
        if (FAILED(hResult))
            return hResult;
 
        return S_OK;
    }

Referenced by UpdateRegistryFromResource().

GetLockCount()

virtual LONG ATL::CAtlModule::GetLockCount ( )

inlinevirtual

Definition at line 472 of file atlbase.h.

    {
        return m_nLockCnt;
    }

Referenced by ATL::CComModule::DllCanUnloadNow().

Lock()

virtual LONG ATL::CAtlModule::Lock ( )

inlinevirtual

Reimplemented in ATL::CAtlExeModuleT< T >, ATL::CAtlExeModuleT< CAtlObjMapModule >, and ATL::CAtlExeModuleT< CCleanMgrModule >.

Definition at line 477 of file atlbase.h.

    {
        return CComGlobalsThreadModel::Increment(&m_nLockCnt);
    }

Unlock()

virtual LONG ATL::CAtlModule::Unlock ( )

inlinevirtual

Reimplemented in ATL::CAtlExeModuleT< T >, ATL::CAtlExeModuleT< CAtlObjMapModule >, and ATL::CAtlExeModuleT< CCleanMgrModule >.

Definition at line 482 of file atlbase.h.

    {
        return CComGlobalsThreadModel::Decrement(&m_nLockCnt);
    }

UpdateRegistryFromResource() [1/2]

HRESULT WINAPI ATL::CAtlModule::UpdateRegistryFromResource ( LPCTSTR  lpszRes, BOOL  bRegister, struct _ATL_REGMAP_ENTRY *  pMapEntries = NULL  )

inline

Definition at line 489 of file atlbase.h.

    {
        CRegObject registrar;
        WCHAR modulePath[MAX_PATH];
        HRESULT hResult;
        PCWSTR lpwszRes;
 
        hResult = CommonInitRegistrar(registrar, modulePath, sizeof(modulePath) / sizeof(modulePath[0]), pMapEntries);
        if (FAILED(hResult))
            return hResult;
#ifdef UNICODE
        lpwszRes = lpszRes;
#else
        /* FIXME: this is a bit of a hack, need to re-evaluate */
        WCHAR resid[MAX_PATH];
        MultiByteToWideChar(CP_ACP, 0, lpszRes, -1, resid, MAX_PATH);
        lpwszRes = resid;
#endif
        if (bRegister != FALSE)
            hResult = registrar.ResourceRegisterSz(modulePath, lpwszRes, L"REGISTRY");
        else
            hResult = registrar.ResourceUnregisterSz(modulePath, lpwszRes, L"REGISTRY");
 
        return hResult;
    }

Referenced by DllRegisterServer(), DllUnregisterServer(), and UpdateRegistryFromResource().

UpdateRegistryFromResource() [2/2]

HRESULT WINAPI ATL::CAtlModule::UpdateRegistryFromResource ( UINT  nResID, BOOL  bRegister, struct _ATL_REGMAP_ENTRY *  pMapEntries = NULL  )

inline

Definition at line 515 of file atlbase.h.

    {
        CRegObject registrar;
        WCHAR modulePath[MAX_PATH];
        HRESULT hResult;
 
        hResult = CommonInitRegistrar(registrar, modulePath, sizeof(modulePath) / sizeof(modulePath[0]), pMapEntries);
        if (FAILED(hResult))
            return hResult;
 
        if (bRegister != FALSE)
            hResult = registrar.ResourceRegister(modulePath, nResID, L"REGISTRY");
        else
            hResult = registrar.ResourceUnregister(modulePath, nResID, L"REGISTRY");
 
        return hResult;
    }

Member Data Documentation

m_libid

GUID ATL::CAtlModule::m_libid

static

Definition at line 462 of file atlbase.h.

Referenced by ATL::CComModule::Init().

---

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

• sdk/lib/atl/atlbase.h