| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>CheckPrototypeDefinition — CMake 3.23.1 Documentation</title> |
| |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/cmake.css" /> |
| |
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
| <script src="../_static/jquery.js"></script> |
| <script src="../_static/underscore.js"></script> |
| <script src="../_static/doctools.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="CheckSourceCompiles" href="CheckSourceCompiles.html" /> |
| <link rel="prev" title="CheckPIESupported" href="CheckPIESupported.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="CheckSourceCompiles.html" title="CheckSourceCompiles" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="CheckPIESupported.html" title="CheckPIESupported" |
| 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> » |
| </li> |
| <li> |
| <a href="../index.html">3.23.1 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">CheckPrototypeDefinition</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="checkprototypedefinition"> |
| <span id="module:CheckPrototypeDefinition"></span><h1>CheckPrototypeDefinition<a class="headerlink" href="#checkprototypedefinition" title="Permalink to this headline">¶</a></h1> |
| <p>Check if the prototype we expect is correct.</p> |
| <dl class="cmake command"> |
| <dt class="sig sig-object cmake" id="command:check_prototype_definition"> |
| <span class="sig-name descname"><span class="pre">check_prototype_definition</span></span><a class="headerlink" href="#command:check_prototype_definition" title="Permalink to this definition">¶</a></dt> |
| <dd><div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">check_prototype_definition(</span><span class="no">FUNCTION</span><span class="w"> </span><span class="no">PROTOTYPE</span><span class="w"> </span><span class="no">RETURN</span><span class="w"> </span><span class="no">HEADER</span><span class="w"> </span><span class="no">VARIABLE</span><span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>FUNCTION - The name of the function (used to check if prototype exists) |
| PROTOTYPE- The prototype to check. |
| RETURN - The return value of the function. |
| HEADER - The header files required. |
| VARIABLE - The variable to store the result. |
| Will be created as an internal cache variable. |
| </pre></div> |
| </div> |
| <p>Example:</p> |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">check_prototype_definition(</span><span class="nb">getpwent_r</span><span class="w"></span> |
| <span class="w"> </span><span class="s">"struct passwd *getpwent_r(struct passwd *src, char *buf, int buflen)"</span><span class="w"></span> |
| <span class="w"> </span><span class="s">"NULL"</span><span class="w"></span> |
| <span class="w"> </span><span class="s">"unistd.h;pwd.h"</span><span class="w"></span> |
| <span class="w"> </span><span class="no">SOLARIS_GETPWENT_R</span><span class="nf">)</span><span class="w"></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <p>The following variables may be set before calling this function to modify |
| the way the check is run:</p> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_FLAGS</span></code></dt><dd><p>string of compile command line flags.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_DEFINITIONS</span></code></dt><dd><p>list of macros to define (-DFOO=bar).</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_INCLUDES</span></code></dt><dd><p>list of include directories.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_LINK_OPTIONS</span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.14: </span>list of options to pass to link command.</p> |
| </div> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_LIBRARIES</span></code></dt><dd><p>list of libraries to link.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CMAKE_REQUIRED_QUIET</span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.1: </span>execute quietly without messages.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| |
| |
| <div class="clearer"></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="CheckPIESupported.html" |
| title="previous chapter">CheckPIESupported</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="CheckSourceCompiles.html" |
| title="next chapter">CheckSourceCompiles</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/module/CheckPrototypeDefinition.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>$('#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="CheckSourceCompiles.html" title="CheckSourceCompiles" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="CheckPIESupported.html" title="CheckPIESupported" |
| >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> » |
| </li> |
| <li> |
| <a href="../index.html">3.23.1 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">CheckPrototypeDefinition</a></li> |
| </ul> |
| </div> |
| |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2022 Kitware, Inc. and Contributors. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2. |
| </div> |
| </body> |
| </html> |