cmake/Help/command/get_cmake_property.rst

21 lines
755 B
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
get_cmake_property
------------------
2016-10-30 18:24:19 +01:00
Get a global property of the CMake instance.
2014-08-03 19:52:23 +02:00
2019-11-11 23:01:05 +01:00
.. code-block:: cmake
2014-08-03 19:52:23 +02:00
2019-11-11 23:01:05 +01:00
get_cmake_property(<var> <property>)
2014-08-03 19:52:23 +02:00
2019-11-11 23:01:05 +01:00
Gets a global property from the CMake instance. The value of
the ``<property>`` is stored in the variable ``<var>``.
If the property is not found, ``<var>`` will be set to ``NOTFOUND``.
See the :manual:`cmake-properties(7)` manual for available properties.
2014-08-03 19:52:23 +02:00
2016-10-30 18:24:19 +01:00
See also the :command:`get_property` command ``GLOBAL`` option.
In addition to global properties, this command (for historical reasons)
also supports the :prop_dir:`VARIABLES` and :prop_dir:`MACROS` directory
properties. It also supports a special ``COMPONENTS`` global property that
lists the components given to the :command:`install` command.