CheckIncludeFileCXX

此模块提供了一个用于检查 C++ 头文件的命令。

在 CMake 项目中加载此模块，使用

include(CheckIncludeFileCXX)

命令

此模块提供以下命令

check_include_file_cxx

检查头文件是否可以在 C++ 代码中包含一次

check_include_file_cxx(<include> <variable> [<flags>])

此命令检查一次给定的 <include> 头文件是否存在并可以包含在 CXX 源文件中。检查结果存储在名为 <variable> 的内部缓存变量中。可选的第三个参数可用于向检查添加额外的编译标志（或使用下面的 CMAKE_REQUIRED_FLAGS 变量）。

影响检查的变量

在调用此命令之前，可以设置以下变量来修改检查的运行方式

CMAKE_REQUIRED_FLAGS

一个空格分隔的字符串，包含要传递给编译器的额外标志。一个 分号分隔列表 将不起作用。CMAKE_<LANG>_FLAGS 及其关联的配置特定 CMAKE_<LANG>_FLAGS_<CONFIG> 变量的内容会自动添加到编译器命令之前，然后是此变量的内容。

CMAKE_REQUIRED_DEFINITIONS

一个 分号分隔列表 的编译器定义，每个定义的形式为 -DFOO 或 -DFOO=bar。还会自动添加一个由检查命令的结果变量参数指定的名称的定义。

CMAKE_REQUIRED_INCLUDES

一个 分号分隔列表 的头文件搜索路径，用于传递给编译器。这些将是唯一使用的头文件搜索路径；INCLUDE_DIRECTORIES 目录属性的内容将被忽略。

CMAKE_REQUIRED_LINK_OPTIONS

3.14 版新增。

一个 分号分隔列表 的选项，用于添加到链接命令（有关更多详细信息，请参见 try_compile()）。

CMAKE_REQUIRED_LIBRARIES

一个 分号分隔列表 的库，用于添加到链接命令。这些可以是系统库的名称，也可以是 导入的目标（有关更多详细信息，请参见 try_compile()）。

CMAKE_REQUIRED_LINK_DIRECTORIES

在版本 3.31 中添加。

一个 分号分隔列表 的库搜索路径，用于传递给链接器（有关更多详细信息，请参见 try_compile()）。

CMAKE_REQUIRED_QUIET

版本 3.1 中新增。

如果此变量评估为布尔真值，则与检查关联的所有状态消息都将被抑制。

版本 3.12 新增： CMAKE_REQUIRED_LIBRARIES 变量，如果策略 CMP0075 设置为 NEW。

示例

检查 C++23 头文件 <stdfloat> 是否存在，并将检查结果存储在 HAVE_STDFLOAT_HEADER 缓存变量中

include(CheckIncludeFileCXX)

check_include_file_cxx(stdfloat HAVE_STDFLOAT_HEADER)

另请参阅