CAtlBaseModule Class
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at CAtlBaseModule Class.
This class is instantiated in every ATL project.
Syntax
class CAtlBaseModule : public _ATL_BASE_MODULE
Members
Public Constructors
| Name | Description |
|---|---|
| CAtlBaseModule::CAtlBaseModule | The constructor. |
Public Methods
| Name | Description |
|---|---|
| CAtlBaseModule::AddResourceInstance | Adds a resource instance to the list of stored handles. |
| CAtlBaseModule::GetHInstanceAt | Returns a handle to a specified resource instance. |
| CAtlBaseModule::GetModuleInstance | Returns the module instance from a CAtlBaseModule object. |
| CAtlBaseModule::GetResourceInstance | Returns the resource instance from a CAtlBaseModule object. |
| CAtlBaseModule::RemoveResourceInstance | Removes a resource instance from the list of stored handles. |
| CAtlBaseModule::SetResourceInstance | Sets the resource instance of a CAtlBaseModule object. |
Public Data Members
| Name | Description |
|---|---|
| CAtlBaseModule::m_bInitFailed | A variable that indicates if the module initialization has failed. |
Remarks
An instance of CAtlBaseModule named _AtlBaseModule is present in every ATL project, containing a handle to the module instance, a handle to the module containing resources (which by default, are one and the same), and an array of handles to modules providing primary resources. CAtlBaseModule can be safely accessed from multiple threads.
This class replaces the obsolete CComModule class used in earlier versions of ATL.
Inheritance Hierarchy
CAtlBaseModule
Requirements
Header: atlcore.h
CAtlBaseModule::AddResourceInstance
Adds a resource instance to the list of stored handles.
bool AddResourceInstance(HINSTANCE hInst) throw();
Parameters
hInst
The resource instance to add.
Return Value
Returns true if the resource was successfully added, false otherwise.
CAtlBaseModule::CAtlBaseModule
The constructor.
CAtlBaseModule() throw();
Remarks
Creates the CAtlBaseModule.
CAtlBaseModule::GetHInstanceAt
Returns a handle to a specified resource instance.
HINSTANCE GetHInstanceAt(int i) throw();
Parameters
i
The number of the resource instance.
Return Value
Returns the handle to the resource instance, or NULL if no corresponding resource instance exists.
CAtlBaseModule::GetModuleInstance
Returns the module instance from a CAtlBaseModule object.
HINSTANCE GetModuleInstance() throw();
Return Value
Returns the module instance.
CAtlBaseModule::GetResourceInstance
Returns the resource instance.
HINSTANCE GetResourceInstance() throw();
Return Value
Returns the resource instance.
CAtlBaseModule::m_bInitFailed
A variable that indicates if the module initialization has failed.
static bool m_bInitFailed;
Remarks
True if the module initialized, false if it failed to initialize.
CAtlBaseModule::RemoveResourceInstance
Removes a resource instance from the list of stored handles.
bool RemoveResourceInstance(HINSTANCE hInst) throw();
Parameters
hInst
The resource instance to remove.
Return Value
Returns true if the resource was successfully removed, false otherwise.
CAtlBaseModule::SetResourceInstance
Sets the resource instance of a CAtlBaseModule object.
HINSTANCE SetResourceInstance(HINSTANCE hInst) throw();
Parameters
hInst
The new resource instance.
Return Value
Returns the updated resource instance.