Files
CMake/Help/command/get_target_property.rst
Christopher Tetreault f4b911a2c9 Help: Update docs for failure result of get_target_property
If `get_target_property` fails to find a value for a non-inherited
property, it appends `-NOTFOUND` to the var name and sets that as the
result, rather than setting the value of the var to `NOTFOUND`.
2020-06-23 08:17:59 -04:00

28 lines
1.1 KiB
ReStructuredText

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 ``<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
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.