CAtlWinModule Class

 

For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.

This class provides support for ATL windowing components.

System_CAPS_ICON_important.jpg Important

This class and its members cannot be used in applications that execute in the Windows Runtime.

class CAtlWinModule : public _ATL_WIN_MODULE

Public Constructors

NameDescription
CAtlWinModule::CAtlWinModuleThe constructor.
CAtlWinModule::~CAtlWinModuleThe destructor.

Public Methods

NameDescription
CAtlWinModule::AddCreateWndDataAdds a data object.
CAtlWinModule::ExtractCreateWndDataReturns a pointer to the window module data object.

This class provides support for all ATL classes which require windowing features.

_ATL_WIN_MODULE

CAtlWinModule

Header: atlbase.h

This method initializes and adds an _AtlCreateWndData structure.

void AddCreateWndData(_AtlCreateWndData* pData, void* pObject);

Parameters

pData
Pointer to the _AtlCreateWndData structure to be initialized and added to the current module.

pObject
Pointer to an object's this pointer.

Remarks

This method calls AtlWinModuleAddCreateWndData which initializes an _AtlCreateWndData structure. This structure will store the this pointer, used to obtain the class instance in window procedures.

The constructor.

CAtlWinModule();

Remarks

If initialization fails, an EXCEPTION_NONCONTINUABLE exception is raised.

The destructor.

~CAtlWinModule();

Remarks

Frees all allocated resources.

This method returns a pointer to an _AtlCreateWndData structure.

void* ExtractCreateWndData();

Return Value

Returns a pointer to the _AtlCreateWndData structure previously added with CAtlWinModule::AddCreateWndData, or NULL if no object is available.

_ATL_WIN_MODULE
Class Overview
Module Classes

Show: