CheckCXXSourceRuns¶
Check once if given C++ source compiles and links into an executable and can subsequently be run.
- check_cxx_source_runs¶
check_cxx_source_runs(<code> <resultVar>)
Check once that the source supplied in
<code>can be built, linked as an executable, and then run. The<code>must contain at least amain()function.The result is stored in the internal cache variable specified by
<resultVar>. If the code builds and runs with exit code0, success is indicated by booleantrue. Failure to build or run is indicated by booleanfalse, such as an empty string or an error message.See also
check_source_runs()for a more general command syntax.The compile and link commands can be influenced by setting any of the following variables prior to calling
check_cxx_source_runs():
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.