pragma-directives-and-the-pragma-keyword.md

title	description	ms.date	f1_keywords	helpviewer_keywords	no-loc
Pragma directives and the __pragma and _Pragma keywords	Describes the pragma directives available in Microsoft Visual C and C++ (MSVC)	03/22/2022	#pragma _Pragma __pragma	#pragma directives, C/C++ __pragma keyword _Pragma keyword pragma directives, C/C++ pragmas, C/C++ preprocessor pragmas preprocessor, pragmas pragma directives (#pragma)	pragma

Pragma directives and the __pragma and _Pragma keywords

Pragma directives specify machine-specific or operating system-specific compiler features. A line that starts with #pragma specifies a pragma directive. The Microsoft-specific __pragma keyword enables you to code pragma directives within macro definitions. The standard _Pragma preprocessor operator, introduced in C99 and adopted by C++11, is similar.

Syntax

#pragma token-string
__pragma( token-string ) // two leading underscores - Microsoft-specific extension
_Pragma( string-literal ) // C99

Remarks

Each implementation of C and C++ supports some features unique to its host machine or operating system. Some programs, for example, must exercise precise control over the location of data in memory, or control the way certain functions receive parameters. The #pragma directives offer a way for each compiler to offer machine- and operating system-specific features, while maintaining overall compatibility with the C and C++ languages.

Pragma directives are machine-specific or operating system-specific by definition, and are typically different for every compiler. A pragma can be used in a conditional directive, to provide new preprocessor functionality. Or, use one to provide implementation-defined information to the compiler.

The token-string is a series of characters representing a specific compiler instruction and arguments, if any. The number sign (#) must be the first non-white-space character on the line that contains the pragma. White-space characters can separate the number sign and the word "pragma". Following #pragma, write any text that the translator can parse as preprocessing tokens. The argument to #pragma is subject to macro expansion.

The string-literal is the input to _Pragma. Outer quotes and leading/trailing whitespace are removed. \" is replaced with " and \\ is replaced with \.

The compiler issues a warning when it finds a pragma that it doesn't recognize, and continues compilation.

The Microsoft C and C++ compilers recognize the following pragma directives:

:::row::: :::column span=""::: alloc_text
auto_inline
bss_seg
check_stack
code_seg
comment
component
conform ¹
const_seg
data_seg
deprecated :::column-end::: :::column span=""::: detect_mismatch
endregion
fenv_access
float_control
fp_contract
function
hdrstop
include_alias
init_seg ¹
inline_depth
inline_recursion :::column-end::: :::column span=""::: intrinsic
loop ¹
make_public
managed
message
omp
once
optimize
pack
pointers_to_members ¹
pop_macro :::column-end::: :::column span=""::: push_macro
region
runtime_checks
section
setlocale
strict_gs_check
system_header
unmanaged
vtordisp ¹
warning :::column-end::: :::row-end:::

¹ Supported only by the C++ compiler.

Pragma directives and compiler options

Some pragma directives provide the same functionality as compiler options. When a pragma is reached in source code, it overrides the behavior specified by the compiler option. For example, if you specified /Zp8, you can override this compiler setting for specific sections of the code with pack:

cl /Zp8 some_file.cpp

// some_file.cpp - packing is 8
// ...
#pragma pack(push, 1) - packing is now 1
// ...
#pragma pack(pop) - packing is 8 again
// ...

The __pragma keyword

The compiler also supports the Microsoft-specific __pragma keyword, which has the same functionality as the #pragma directive. The difference is, the __pragma keyword is usable inline in a macro definition. The #pragma directive isn't usable in a macro definition, because the compiler interprets the number sign character ('#') in the directive as the stringizing operator (#).

The following code example demonstrates how the __pragma keyword can be used in a macro. This code is excerpted from the mfcdual.h header in the ACDUAL sample in "Compiler COM Support Samples":

#define CATCH_ALL_DUAL \
CATCH(COleException, e) \
{ \
_hr = e->m_sc; \
} \
AND_CATCH_ALL(e) \
{ \
__pragma(warning(push)) \
__pragma(warning(disable:6246)) /*disable _ctlState prefast warning*/ \
AFX_MANAGE_STATE(pThis->m_pModuleState); \
__pragma(warning(pop)) \
_hr = DualHandleException(_riidSource, e); \
} \
END_CATCH_ALL \
return _hr; \

The _Pragma preprocessing operator

_Pragma is similar to the Microsoft-specific __pragma keyword. It was introduced into the C standard in C99, and the C++ standard in C++11. It's available in C only when you specify the /std:c11 or /std:c17 option. For C++, it's available in all /std modes, including the default.

Unlike #pragma, _Pragma allows you to put pragma directives into a macro definition. The string literal should be what you would otherwise put following a #pragma statement. For example:

#pragma message("the #pragma way")
_Pragma ("message( \"the _Pragma way\")") 

Quotation marks and back-slashes should be escaped, as shown above. A pragma string that isn't recognized is ignored.

The following code example demonstrates how the _Pragma keyword could be used in an assert-like macro. It creates a pragma directive that suppresses a warning when the condition expression happens to be constant.

The macro definition uses the do ... while(0) idiom for multi-statement macros so that it can be used as though it were one statement. For more information, see C multi-line macro on Stack Overflow. The _Pragma statement in the example only applies to the line of code that follows it.

// Compile with /W4

#include <stdio.h>
#include <stdlib.h>

#define MY_ASSERT(BOOL_EXPRESSION) \
    do { \
        _Pragma("warning(suppress: 4127)") /* C4127 conditional expression is constant */  \
        if (!(BOOL_EXPRESSION)) {   \
            printf("MY_ASSERT FAILED: \"" #BOOL_EXPRESSION "\" on %s(%d)", __FILE__, __LINE__); \
            exit(-1); \
        } \
    } while (0)

int main()
{
    MY_ASSERT(0 && "Note that there is no warning: C4127 conditional expression is constant");

    return 0;
}

See also

C/C++ preprocessor reference
C pragma directives
Keywords