cmake/Help/command/get_target_property.rst

28 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
get_target_property
-------------------
Get a property from a target.
2019-11-11 23:01:05 +01:00
.. code-block:: cmake
2014-08-03 19:52:23 +02:00
2020-08-30 11:54:41 +02:00
get_target_property(<VAR> target property)
2014-08-03 19:52:23 +02:00
Get a property from a target. The value of the property is stored in
2020-08-30 11:54:41 +02:00
the variable ``<VAR>``. If the target property is not found, the behavior
2018-08-09 18:06:22 +02:00
depends on whether it has been defined to be an ``INHERITED`` property
or not (see :command:`define_property`). Non-inherited properties will
2020-08-30 11:54:41 +02:00
set ``<VAR>`` to ``<VAR>-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
2018-08-09 18:06:22 +02:00
an empty string.
Use :command:`set_target_properties` to set target property values.
2014-08-03 19:52:23 +02:00
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
2016-03-13 13:35:51 +01:00
``CMakeLists.txt`` file.
2014-08-03 19:52:23 +02:00
2015-11-17 17:22:37 +01:00
See also the more general :command:`get_property` command.
2019-11-11 23:01:05 +01:00
See :ref:`Target Properties` for the list of properties known to CMake.