blob: fa60172f0aae1f8863fbc61b146ededfd7267824 [file] [log] [blame]
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>LOCATION &mdash; CMake 3.23.1 Documentation</title>
<link rel="stylesheet" href="../_static/cmake.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/cmake-favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="LOCATION_&lt;CONFIG&gt;" href="LOCATION_CONFIG.html" />
<link rel="prev" title="LINKER_LANGUAGE" href="LINKER_LANGUAGE.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="LOCATION_CONFIG.html" title="LOCATION_&lt;CONFIG&gt;"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="LINKER_LANGUAGE.html" title="LINKER_LANGUAGE"
accesskey="P">previous</a> |</li>
<li>
<img src="../_static/cmake-logo-16.png" alt=""
style="vertical-align: middle; margin-top: -2px" />
</li>
<li>
<a href="https://cmake.org/">CMake</a> &#187;
</li>
<li>
<a href="../index.html">3.23.1 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" accesskey="U">cmake-properties(7)</a> &#187;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="location">
<span id="prop_tgt:LOCATION"></span><h1>LOCATION<a class="headerlink" href="#location" title="Permalink to this headline">ΒΆ</a></h1>
<p>Read-only location of a target on disk.</p>
<p>For an imported target, this read-only property returns the value of
the <code class="docutils literal notranslate"><span class="pre">LOCATION_&lt;CONFIG&gt;</span></code> property for an unspecified configuration
<code class="docutils literal notranslate"><span class="pre">&lt;CONFIG&gt;</span></code> provided by the target.</p>
<p>For a non-imported target, this property is provided for compatibility
with CMake 2.4 and below. It was meant to get the location of an
executable target's output file for use in <span class="target" id="index-0-command:add_custom_command"></span><a class="reference internal" href="../command/add_custom_command.html#command:add_custom_command" title="add_custom_command"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">add_custom_command()</span></code></a>. The
path may contain a build-system-specific portion that is replaced at
build time with the configuration getting built (such as
<code class="docutils literal notranslate"><span class="pre">$(ConfigurationName)</span></code> in VS). In CMake 2.6 and above
<span class="target" id="index-1-command:add_custom_command"></span><a class="reference internal" href="../command/add_custom_command.html#command:add_custom_command" title="add_custom_command"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">add_custom_command()</span></code></a> automatically recognizes a target name in its
<code class="docutils literal notranslate"><span class="pre">COMMAND</span></code> and <code class="docutils literal notranslate"><span class="pre">DEPENDS</span></code> options and computes the target location. In
CMake 2.8.4 and above <span class="target" id="index-2-command:add_custom_command"></span><a class="reference internal" href="../command/add_custom_command.html#command:add_custom_command" title="add_custom_command"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">add_custom_command()</span></code></a> recognizes
<span class="target" id="index-0-manual:cmake-generator-expressions(7)"></span><a class="reference internal" href="../manual/cmake-generator-expressions.7.html#manual:cmake-generator-expressions(7)" title="cmake-generator-expressions(7)"><code class="xref cmake cmake-manual docutils literal notranslate"><span class="pre">generator</span> <span class="pre">expressions</span></code></a>
to refer to target locations anywhere in the command.
Therefore this property is not needed for creating custom commands.</p>
<p>Do not set properties that affect the location of a target after
reading this property. These include properties whose names match
<code class="docutils literal notranslate"><span class="pre">(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_&lt;CONFIG&gt;)?</span></code>,
<code class="docutils literal notranslate"><span class="pre">(IMPLIB_)?(PREFIX|SUFFIX)</span></code>, or &quot;LINKER_LANGUAGE&quot;. Failure to follow
this rule is not diagnosed and leaves the location of the target
undefined.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="LINKER_LANGUAGE.html"
title="previous chapter">LINKER_LANGUAGE</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="LOCATION_CONFIG.html"
title="next chapter">LOCATION_&lt;CONFIG&gt;</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/prop_tgt/LOCATION.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="LOCATION_CONFIG.html" title="LOCATION_&lt;CONFIG&gt;"
>next</a> |</li>
<li class="right" >
<a href="LINKER_LANGUAGE.html" title="LINKER_LANGUAGE"
>previous</a> |</li>
<li>
<img src="../_static/cmake-logo-16.png" alt=""
style="vertical-align: middle; margin-top: -2px" />
</li>
<li>
<a href="https://cmake.org/">CMake</a> &#187;
</li>
<li>
<a href="../index.html">3.23.1 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" >cmake-properties(7)</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2000-2022 Kitware, Inc. and Contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
</div>
</body>
</html>