cmake/Help/command/get_cmake_property.rst

24 lines
782 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
2024-02-02 17:42:32 +01:00
get_cmake_property(<variable> <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
2024-02-02 17:42:32 +01:00
the ``<property>`` is stored in the specified ``<variable>``.
If the property is not found, ``<variable>`` will be set to ``NOTFOUND``.
2019-11-11 23:01:05 +01:00
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
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.
2023-05-23 16:38:00 +02:00
See Also
^^^^^^^^
* the :command:`get_property` command ``GLOBAL`` option