CheckIncludeFileCXX¶
Provides a macro to check if a header file can be included in CXX.
- check_include_file_cxx¶
check_include_file_cxx(<include> <variable> [<flags>])
Check if the given
<include>file may be included in aCXXsource file and store the result in an internal cache entry named<variable>. The optional third argument may be used to add compilation flags to the check (or useCMAKE_REQUIRED_FLAGSbelow).
The following variables may be set before calling this macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGSString of additional flags to pass to the compiler. The string must be space-delimited--a ;-list will not work. The contents of
CMAKE_<LANG>_FLAGSand its associated configuration-specific variable are automatically added to the compiler command before the contents ofCMAKE_REQUIRED_FLAGS.
CMAKE_REQUIRED_DEFINITIONSA ;-list of compiler definitions of the form
-DFOOor-DFOO=bar. A definition for the name specified by<resultVar>will also be added automatically.
CMAKE_REQUIRED_INCLUDESA ;-list of header search paths to pass to the compiler. These will be the only header search paths used--the contents of the
INCLUDE_DIRECTORIESdirectory property will be ignored.
CMAKE_REQUIRED_LINK_OPTIONSAdded in version 3.14.
A ;-list of options to add to the link command (see
try_compile()for further details).
CMAKE_REQUIRED_LIBRARIESA ;-list of libraries to add to the link command. These can be the name of system libraries or they can be Imported Targets (see
try_compile()for further details).
CMAKE_REQUIRED_LINK_DIRECTORIESAdded in version 3.31.
A ;-list of libraries search paths to pass to the linker (see
try_compile()for further details).
CMAKE_REQUIRED_QUIETAdded in version 3.1.
If this variable evaluates to a boolean true value, all status messages associated with the check will be suppressed.
See modules CheckIncludeFile and CheckIncludeFiles
to check for one or more C headers.