Compiler Options Macros

 

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 Compiler Options Macros.

These macros control specific compiler features.

_ATL_ALL_WARNINGSA symbol which enables errors in projects converted from previous versions of ATL.
_ATL_APARTMENT_THREADEDDefine if one or more of your objects use apartment threading.
_ATL_CSTRING_EXPLICIT_CONSTRUCTORSMakes certain CString constructors explicit, preventing any unintentional conversions.
_ATL_ENABLE_PTM_WARNINGDefine this macro in order to use C++ standard compliant syntax, which generates the C4867 compiler error when a non standard syntax is used to initialize a pointer to a member function.
_ATL_FREE_THREADEDDefine if one or more of your objects use free or neutral threading.
_ATL_MULTI_THREADEDA symbol that indicates the project will have objects that are marked as Both, Free or Neutral. The macro _ATL_FREE_THREADED should be used instead.
_ATL_NO_AUTOMATIC_NAMESPACEA symbol which prevents the default use of namespace as ATL.
_ATL_NO_COM_SUPPORTA symbol which prevents COM-related code from being compiled with your project.
ATL_NO_VTABLEA symbol that prevents the vtable pointer from being initialized in the class's constructor and destructor.
ATL_NOINLINEA symbol that indicates a function should not be inlined.
_ATL_SINGLE_THREADEDDefine if all of your objects use the single threading model.

A symbol which enables errors in projects converted from previous versions of ATL.

#define _ATL_ALL_WARNINGS

Remarks

Before Visual C++ .NET 2002, ATL disabled a lot of warnings and left them disabled so that they never showed up in user code. Specifically:

  • C4127 conditional expression is constant

  • C4786 'identifier' : identifier was truncated to 'number' characters in the debug information

  • C4201 nonstandard extension used : nameless struct/union

  • C4103 'filename' : used #pragma pack to change alignment

  • C4291 'declaration' : no matching operator delete found; memory will not be freed if initialization throws an exception

  • C4268 'identifier' : 'const' static/global data initialized with compiler generated default constructor fills the object with zeros

  • C4702 unreachable code

In projects converted from previous versions, these warnings are still disabled by the libraries headers.

By adding the following line to the stdafx.h file before including libraries headers, this behavior can be changed.

#define _ATL_ALL_WARNINGS

If this #define is added, the ATL headers are careful to preserve the state of these warnings so that they are not disabled globally (or if the user explicitly disables individual warnings, not to enable them).

New projects generated with Visual C++ .NET 2002 will have this #define set in stdafx.h by default.

Define if one or more of your objects use apartment threading.

_ATL_APARTMENT_THREADED

Remarks

Specifies apartment threading. See Specifying the Project's Threading Model for other threading options, and Options, ATL Simple Object Wizard for a description of the threading models available for an ATL object.

Makes certain CString constructors explicit, preventing any unintentional conversions.

_ATL_CSTRING_EXPLICIT_CONSTRUCTORS

Remarks

When this is defined, all CString constructors that take a single parameter are compiled with the explicit keyword, which prevents implicit conversions of input arguments. This means for example, that when _UNICODE is defined, if you attempt use a char* string as a CString constructor argument, a compiler error will result. Use this macro in situations where you need to prevent implicit conversions between narrow and wide string types.

By using the _T macro on all constructor string arguments, you can define _ATL_CSTRING_EXPLICIT_CONSTRUCTORS and avoid compile errors regardless of whether _UNICODE is defined.

Define this macro in order to force the use of ANSI C++ standard-compliant syntax for pointer to member functions. Using this macro will cause the C4867 compiler error to be generated when non-standard syntax is used to initialize a pointer to a member function.

#define _ATL_ENABLE_PTM_WARNING

Remarks

The ATL and MFC libraries have been changed to match the Visual C++ compiler's improved standard C++ compliance. According to the ANSI C++ standard, the syntax of a pointer to a class member function should be &CMyClass::MyFunc.

When _ATL_ENABLE_PTM_WARNING is not defined (the default case), ATL/MFC disables the C4867 error in macro maps (notably message maps) so that code that was created in earlier versions can continue to build as before. If you define _ATL_ENABLE_PTM_WARNING, your code should be C++ standard compliant.

However, the non-standard form has been deprecated, so you need to move existing code to C++ standard compliant syntax. For example, the following:

BEGIN_MESSAGE_MAP(CMFCListViewDoc, CDocument)
   ON_COMMAND(ID_MYCOMMAND, OnMycommand)
END_MESSAGE_MAP()

Should be changed to:

BEGIN_MESSAGE_MAP(CMFCListViewDoc, CDocument)
   ON_COMMAND(ID_MYCOMMAND, &CMFCListViewDoc::OnMycommand)
END_MESSAGE_MAP()

Note that for map macros that add the '&' character, you should not add it again in your code.

Define if one or more of your objects use free or neutral threading.

_ATL_FREE_THREADED

Remarks

Specifies free threading. Free threading is equivalent to a multithread apartment model. See Specifying the Project's Threading Model for other threading options, and Options, ATL Simple Object Wizard for a description of the threading models available for an ATL object.

A symbol that indicates the project will have objects that are marked as Both, Free or Neutral.

_ATL_MULTI_THREADED

Remarks

If this symbol is defined, ATL will pull in code that will correctly synchronize access to global data. New code should use the equivalent macro _ATL_FREE_THREADED instead.

A symbol which prevents the default use of namespace as ATL.

_ATL_NO_AUTOMATIC_NAMESPACE

Remarks

If this symbol is not defined, including atlbase.h will perform using namespace ATL by default, which may lead to naming conflicts. To prevent this, define this symbol.

A symbol which prevents COM-related code from being compiled with your project.

_ATL_NO_COM_SUPPORT```  
  
##  <a name="atl_no_vtable"></a>  ATL_NO_VTABLE  
 A symbol that prevents the vtable pointer from being initialized in the class's constructor and destructor.  
  

ATL_NO_VTABLE

  
### Remarks  
 If the vtable pointer is prevented from being initialized in the class's constructor and destructor, the linker can eliminate the vtable and all of the functions to which it points. Expands to **__declspec(novtable)**.  
  
### Example  
 [!CODE [NVC_ATL_COM#53](../CodeSnippet/VS_Snippets_Cpp/NVC_ATL_COM#53)]  
  
##  <a name="atl_noinline"></a>  ATL_NOINLINE  
 A symbol that indicates a function should not be inlined.  
  

ATL_NOINLINE inline myfunction { ... }

  
### Parameters  
 *myfunction*  
 The function that should not be inlined.  
  
### Remarks  
 Use this symbol if you want to ensure a function does not get inlined by the compiler, even though it must be declared as inline so that it can be placed in a header file. Expands to **__declspec(noinline)**.  
  
##  <a name="_atl_single_threaded"></a>  _ATL_SINGLE_THREADED  
 Define if all of your objects use the single threading model  
  

_ATL_SINGLE_THREADED

  
### Remarks  
 Specifies that the object always runs in the primary COM thread. See [Specifying the Project's Threading Model](../Topic/Specifying%20the%20Threading%20Model%20for%20a%20Project%20\(ATL\).md) for other threading options, and [Options, ATL Simple Object Wizard](../Topic/Options,%20ATL%20Simple%20Object%20Wizard.md) for a description of the threading models available for an ATL object.  
  
## See Also  
 [Macros](../Topic/ATL%20Macros.md)





Show: