summaryrefslogtreecommitdiff
path: root/share/cmake-3.22/Help/command/get_cmake_property.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.22/Help/command/get_cmake_property.rst')
-rw-r--r--share/cmake-3.22/Help/command/get_cmake_property.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/share/cmake-3.22/Help/command/get_cmake_property.rst b/share/cmake-3.22/Help/command/get_cmake_property.rst
new file mode 100644
index 0000000..96764a3
--- /dev/null
+++ b/share/cmake-3.22/Help/command/get_cmake_property.rst
@@ -0,0 +1,20 @@
+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.
+
+See also the :command:`get_property` command ``GLOBAL`` option.
+
+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.