get_source_file_property

Get a property for a source file.

get_source_file_property(VAR file [<TARGET_DIRECTORY ... | DIRECTORY ...>] property)

Gets 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 define_property()). Non-inherited properties will set VAR to “NOTFOUND”, whereas inherited properties will search the relevant parent scope as described for the define_property() command and if still unable to find the property, VAR will be set to an empty string.

The queried source file scope can be changed by specifying one of the additional options: DIRECTORY or TARGET_DIRECTORY.

DIRECTORY takes a path to a processed directory, and the source file property will be read from that directory scope.

TARGET_DIRECTORY takes the name of an existing target. The source file property will be read from this target’s directory scope.

Use 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 LOCATION.

See also the more general get_property() command.