OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 add_compile_definitions.html	8.97 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_compile_options.html	13.11 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_custom_command.html	67.2 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_custom_target.html	26.7 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_definitions.html	9.72 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_dependencies.html	8.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_executable.html	20.23 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_library.html	43.25 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_link_options.html	17.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_subdirectory.html	8.85 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_test.html	17.09 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 aux_source_directory.html	6.45 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 block.html	13.15 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 break.html	5.97 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_command.html	10.66 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_name.html	6.43 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_host_system_information.html	38.46 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_language.html	59.74 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_minimum_required.html	13.56 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_parse_arguments.html	18.62 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_path.html	80.45 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_policy.html	23.14 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 configure_file.html	20.36 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 continue.html	6.15 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 create_test_sourcelist.html	7.61 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_build.html	14.87 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_configure.html	10.28 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_coverage.html	9.93 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_empty_binary_directory.html	5.54 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_memcheck.html	11.73 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_read_custom_files.html	5.78 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_run_script.html	6.72 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_sleep.html	5.66 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_start.html	14.68 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_submit.html	16.18 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_test.html	38.64 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_update.html	8.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_upload.html	6.7 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 define_property.html	15.53 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 else.html	5.35 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 elseif.html	5.44 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_language.html	10.08 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_testing.html	6.04 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endblock.html	5.66 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endforeach.html	5.88 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endfunction.html	5.85 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endif.html	5.71 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endmacro.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endwhile.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 exec_program.html	7.52 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 execute_process.html	20.95 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export.html	19.49 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export_library_dependencies.html	8.01 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 file.html	128.25 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_file.html	39.65 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_library.html	46.52 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_package.html	91.29 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_path.html	40.22 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_program.html	37.17 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 fltk_wrap_ui.html	5.8 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 foreach.html	18.65 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 function.html	12.42 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_cmake_property.html	8.05 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_directory_property.html	9.08 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_filename_component.html	12.57 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_property.html	15.95 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_source_file_property.html	11.47 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_target_property.html	9.1 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_test_property.html	8.06 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 if.html	41.89 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include.html	8.04 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_directories.html	10.54 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_external_msproject.html	8.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_guard.html	8.85 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_regular_expression.html	6.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install.html	126.44 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_files.html	9.13 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_programs.html	9.09 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_targets.html	7 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_directories.html	11.99 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_libraries.html	7.36 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 list.html	35.79 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_cache.html	6.78 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_command.html	6.61 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 macro.html	20.49 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 make_directory.html	5.77 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 mark_as_advanced.html	6.73 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 math.html	9.01 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 message.html	27.67 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 option.html	6.48 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 output_required_files.html	6.59 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 project.html	30.84 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_cpp.html	7.2 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_ui.html	7.43 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove.html	6 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove_definitions.html	6.15 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 return.html	16.06 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 separate_arguments.html	11.04 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set.html	18.35 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_directory_properties.html	7.58 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_property.html	17.74 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_source_files_properties.html	10.63 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_target_properties.html	8.33 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_tests_properties.html	7.98 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 site_name.html	5.46 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 source_group.html	10.97 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 string.html	64.24 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdir_depends.html	5.69 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdirs.html	7.51 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_definitions.html	16.09 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_features.html	14.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_options.html	18.02 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_include_directories.html	22.39 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_directories.html	16.03 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_libraries.html	60.83 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_options.html	23.66 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_precompile_headers.html	24.42 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_sources.html	38.35 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_compile.html	57.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_run.html	24.62 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 unset.html	9.21 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 use_mangled_mesa.html	5.91 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 utility_source.html	6.78 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_requires.html	6.84 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_watch.html	8.98 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 while.html	9.14 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 write_file.html	7.25 KB	04/04/2023 07:05:04 PM	rw-r--r--

Editing: function.html

<!DOCTYPE html>

<title>function &mdash; CMake 3.26.3 Documentation</title>

</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="get_cmake_property.html" title="get_cmake_property"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="foreach.html" title="foreach"
             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.26.3 Documentation</a> &#187;
  </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">function</a></li> 
      </ul>
    </div>

<div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="function">
<span id="command:function"></span><h1>function<a class="headerlink" href="#function" title="Permalink to this heading">¶</a></h1>
<p>Start recording a function for later invocation as a command.</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">function(</span><span class="nv">&lt;name&gt;</span><span class="w"> </span><span class="p">[</span><span class="nv">&lt;arg1&gt;</span><span class="w"> </span><span class="p">...]</span><span class="nf">)</span><span class="w"></span>
<span class="w">  </span><span class="nv">&lt;commands&gt;</span><span class="w"></span>
<span class="nf">endfunction()</span><span class="w"></span>
</pre></div>
</div>
<p>Defines a function named <code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code> that takes arguments named
<code class="docutils literal notranslate"><span class="pre">&lt;arg1&gt;</span></code>, ...  The <code class="docutils literal notranslate"><span class="pre">&lt;commands&gt;</span></code> in the function definition
are recorded; they are not executed until the function is invoked.</p>
<p>Per legacy, the <span class="target" id="index-0-command:endfunction"></span><a class="reference internal" href="endfunction.html#command:endfunction" title="endfunction"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">endfunction()</span></code></a> command admits an optional
<code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code> argument. If used, it must be a verbatim repeat of the
argument of the opening <code class="docutils literal notranslate"><span class="pre">function</span></code> command.</p>
<p>A function opens a new scope: see <span class="target" id="index-0-command:set"></span><a class="reference internal" href="set.html#command:set" title="set"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set(var</span> <span class="pre">PARENT_SCOPE)</span></code></a> for
details.</p>
<p>See the <span class="target" id="index-0-command:cmake_policy"></span><a class="reference internal" href="cmake_policy.html#command:cmake_policy" title="cmake_policy"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cmake_policy()</span></code></a> command documentation for the behavior
of policies inside functions.</p>
<p>See the <span class="target" id="index-0-command:macro"></span><a class="reference internal" href="macro.html#command:macro" title="macro"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">macro()</span></code></a> command documentation for differences
between CMake functions and macros.</p>
<section id="invocation">
<h2>Invocation<a class="headerlink" href="#invocation" title="Permalink to this heading">¶</a></h2>
<p>The function invocation is case-insensitive. A function defined as</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">function(</span><span class="nb">foo</span><span class="nf">)</span><span class="w"></span>
<span class="w">  </span><span class="nv">&lt;commands&gt;</span><span class="w"></span>
<span class="nf">endfunction()</span><span class="w"></span>
</pre></div>
</div>
<p>can be invoked through any of</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">foo()</span><span class="w"></span>
<span class="nf">Foo()</span><span class="w"></span>
<span class="nf">FOO()</span><span class="w"></span>
<span class="nf">cmake_language(</span><span class="no">CALL</span><span class="w"> </span><span class="nb">foo</span><span class="nf">)</span><span class="w"></span>
</pre></div>
</div>
<p>and so on. However, it is strongly recommended to stay with the
case chosen in the function definition. Typically functions use
all-lowercase names.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.18: </span>The <span class="target" id="index-0-command:cmake_language"></span><a class="reference internal" href="cmake_language.html#command:cmake_language" title="cmake_language"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cmake_language(CALL</span> <span class="pre">...)</span></code></a> command can also be used to
invoke the function.</p>
</div>
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading">¶</a></h2>
<p>When the function is invoked, the recorded <code class="docutils literal notranslate"><span class="pre">&lt;commands&gt;</span></code> are first
modified by replacing formal parameters (<code class="docutils literal notranslate"><span class="pre">${arg1}</span></code>, ...) with the
arguments passed, and then invoked as normal commands.</p>
<p>In addition to referencing the formal parameters you can reference the
<code class="docutils literal notranslate"><span class="pre">ARGC</span></code> variable which will be set to the number of arguments passed
into the function as well as <code class="docutils literal notranslate"><span class="pre">ARGV0</span></code>, <code class="docutils literal notranslate"><span class="pre">ARGV1</span></code>, <code class="docutils literal notranslate"><span class="pre">ARGV2</span></code>, ...  which
will have the actual values of the arguments passed in.  This facilitates
creating functions with optional arguments.</p>
<p>Furthermore, <code class="docutils literal notranslate"><span class="pre">ARGV</span></code> holds the list of all arguments given to the
function and <code class="docutils literal notranslate"><span class="pre">ARGN</span></code> holds the list of arguments past the last expected
argument.  Referencing to <code class="docutils literal notranslate"><span class="pre">ARGV#</span></code> arguments beyond <code class="docutils literal notranslate"><span class="pre">ARGC</span></code> have
undefined behavior.  Checking that <code class="docutils literal notranslate"><span class="pre">ARGC</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">#</span></code> is
the only way to ensure that <code class="docutils literal notranslate"><span class="pre">ARGV#</span></code> was passed to the function as an
extra argument.</p>
</section>
<section id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p><span class="target" id="index-0-command:cmake_parse_arguments"></span><a class="reference internal" href="cmake_parse_arguments.html#command:cmake_parse_arguments" title="cmake_parse_arguments"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cmake_parse_arguments()</span></code></a></p></li>
<li><p><span class="target" id="index-1-command:endfunction"></span><a class="reference internal" href="endfunction.html#command:endfunction" title="endfunction"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">endfunction()</span></code></a></p></li>
<li><p><span class="target" id="index-0-command:return"></span><a class="reference internal" href="return.html#command:return" title="return"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">return()</span></code></a></p></li>
</ul>
</section>
</section>

<div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
<li><a class="reference internal" href="#">function</a><ul>
<li><a class="reference internal" href="#invocation">Invocation</a></li>
<li><a class="reference internal" href="#arguments">Arguments</a></li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
</ul>

</div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="foreach.html"
                          title="previous chapter">foreach</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="get_cmake_property.html"
                          title="next chapter">get_cmake_property</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/command/function.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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</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="get_cmake_property.html" title="get_cmake_property"
             >next</a> |</li>
        <li class="right" >
          <a href="foreach.html" title="foreach"
             >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.26.3 Documentation</a> &#187;
  </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">function</a></li> 
      </ul>
    </div>

<div class="footer" role="contentinfo">
        &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
    </div>
  </body>
</html>