summaryrefslogtreecommitdiff
path: root/share/cmake-3.17/Help/command/get_target_property.rst
blob: 11e07eabe78aa8f1c6ddd41b79dd1746fb1c5d2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
get_target_property
-------------------

Get a property from a target.

.. code-block:: cmake

  get_target_property(VAR target property)

Get a property from a target.  The value of the property is stored in
the variable ``VAR``.  If the target property is not found, the behavior
depends on whether it has been defined to be an ``INHERITED`` property
or not (see :command:`define_property`).  Non-inherited properties will
set ``VAR`` to ``NOTFOUND``, whereas inherited properties will search the
relevant parent scope as described for the :command:`define_property`
command and if still unable to find the property, ``VAR`` will be set to
an empty string.

Use :command:`set_target_properties` to set target property values.
Properties are usually used to control how a target is built, but some
query the target instead.  This command can get properties for any
target so far created.  The targets do not need to be in the current
``CMakeLists.txt`` file.

See also the more general :command:`get_property` command.

See :ref:`Target Properties` for the list of properties known to CMake.