Check if given C source compiles and links into an executable and can subsequently be run.
Check that the source supplied in
<code>can be compiled as a C source file, linked as an executable and then run. The
<code>must contain at least a
main()function. If the
<code>could be built and run successfully, the internal cache variable specified by
<resultVar>will be set to 1, otherwise it will be set to an value that evaluates to boolean false (e.g. an empty string or an error message).
The check is only performed once, with the result cached in the variable named by
<resultVar>. Every subsequent CMake run will reuse this cached value rather than performing the check again, even if the
<code>changes. In order to force the check to be re-evaluated, the variable named by
<resultVar>must be manually removed from the cache.
The compile and link commands can be influenced by setting any of the following variables prior to calling
String 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 of
A ;-list of compiler definitions of the form
-DFOO=bar. A definition for the name specified by
<resultVar>will also be added automatically.
New in version 3.1.
If this variable evaluates to a boolean true value, all status messages associated with the check will be suppressed.