Share via


AfxGetAppModuleState

From the main executable, call this function to set the module state before initialization or to restore the previous module state after cleanup.

AFX_MODULE_STATE* AFXAPI AfxGetAppModuleState( );

Return Value

A pointer to an AFX_MODULE_STATE structure.

Remarks

The AFX_MODULE_STATE structure contains global data for the module, that is, the portion of the module state that is pushed or popped.

By default, MFC uses the resource handle of the main application to load the resource template. If you have an exported function in a DLL, such as one that launches a dialog box in the DLL, this template is actually stored in the DLL module. You need to switch the module state for the correct handle to be used. You can do this by adding the following code to the beginning of the function:

AFX_MANAGE_STATE(AfxGetAppModuleState( ));

This swaps the current module state with the state returned from AfxGetAppModuleState until the end of the current scope.

To set or restore the module state from a DLL function, do not use AfxGetAppModuleState. Instead, use AfxGetStaticModuleState.

For more information on module states and MFC, see Managing the State Data of MFC Modules in Creating New Documents, Windows, and Views and Technical Note 58.

Requirements

Header: afxstat_.h

See Also

Reference

AFX_MANAGE_STATE

AfxGetStaticModuleState

Concepts

MFC Macros and Globals