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

Get a property for a source file.

::

  get_source_file_property(VAR file property)

Get a property from a source file.  The value of the property is
stored in the variable ``VAR``.  If the source 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 inheritied properties will search the relevent
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_source_files_properties` to set property values.  Source
file properties usually control how the file is built. One property that is
always there is :prop_sf:`LOCATION`.

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