summaryrefslogtreecommitdiffstats
path: root/Help/command/get_cmake_property.rst
blob: b1d18a0d8e0e3b67fd1bf73f71531004855d6a51 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
get_cmake_property
------------------

Get a global property of the CMake instance.

.. code-block:: cmake

  get_cmake_property(<var> <property>)

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.

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.

See Also
^^^^^^^^

* the :command:`get_property` command ``GLOBAL`` option