| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 6 |
<meta name="generator" content="Doxygen 1.15.0"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>Hardware Locality (hwloc): API version</title> |
| 9 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 |
<script type="text/javascript" src="jquery.js"></script> |
| 11 |
<script type="text/javascript" src="dynsections.js"></script> |
| 12 |
<script type="text/javascript" src="clipboard.js"></script> |
| 13 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 14 |
</head> |
| 15 |
<body> |
| 16 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 17 |
<div id="titlearea"> |
| 18 |
<table cellspacing="0" cellpadding="0"> |
| 19 |
<tbody> |
| 20 |
<tr id="projectrow"> |
| 21 |
<td id="projectalign"> |
| 22 |
<div id="projectname">Hardware Locality (hwloc)<span id="projectnumber"> 2.14.0</span> |
| 23 |
</div> |
| 24 |
</td> |
| 25 |
</tr> |
| 26 |
</tbody> |
| 27 |
</table> |
| 28 |
</div> |
| 29 |
<!-- end header part --> |
| 30 |
<!-- Generated by Doxygen 1.15.0 --> |
| 31 |
<script type="text/javascript"> |
| 32 |
$(function() { codefold.init(); }); |
| 33 |
</script> |
| 34 |
<script type="text/javascript" src="menudata.js"></script> |
| 35 |
<script type="text/javascript" src="menu.js"></script> |
| 36 |
<script type="text/javascript"> |
| 37 |
$(function() { |
| 38 |
initMenu('',false,false,'search.php','Search',false); |
| 39 |
}); |
| 40 |
</script> |
| 41 |
<div id="main-nav"></div> |
| 42 |
</div><!-- top --> |
| 43 |
<div id="doc-content"> |
| 44 |
<div class="header"> |
| 45 |
<div class="summary"> |
| 46 |
<a href="#define-members">Macros</a> | |
| 47 |
<a href="#func-members">Functions</a> </div> |
| 48 |
<div class="headertitle"><div class="title">API version </div></div> |
| 49 |
</div><!--header--> |
| 50 |
<div class="contents"> |
| 51 |
<table class="memberdecls"> |
| 52 |
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a> |
| 53 |
Macros</h2></td></tr> |
| 54 |
<tr class="memitem:ga8f4dfb8eef138af55dd1a0fa802e5476" id="r_ga8f4dfb8eef138af55dd1a0fa802e5476"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8f4dfb8eef138af55dd1a0fa802e5476">HWLOC_API_VERSION</a>   0x00020c00</td></tr> |
| 55 |
<tr class="memitem:gaac5bc1f46f55e10ef0141a68ce70e21f" id="r_gaac5bc1f46f55e10ef0141a68ce70e21f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaac5bc1f46f55e10ef0141a68ce70e21f">HWLOC_COMPONENT_ABI</a>   7</td></tr> |
| 56 |
</table><table class="memberdecls"> |
| 57 |
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a> |
| 58 |
Functions</h2></td></tr> |
| 59 |
<tr class="memitem:ga9c0b50c98add1adf57ed1ce85bb5190d" id="r_ga9c0b50c98add1adf57ed1ce85bb5190d"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9c0b50c98add1adf57ed1ce85bb5190d">hwloc_get_api_version</a> (void)</td></tr> |
| 60 |
</table> |
| 61 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 62 |
<a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2> |
| 63 |
<a id="ga8f4dfb8eef138af55dd1a0fa802e5476" name="ga8f4dfb8eef138af55dd1a0fa802e5476"></a> |
| 64 |
<h2 class="memtitle"><span class="permalink"><a href="#ga8f4dfb8eef138af55dd1a0fa802e5476">◆ </a></span>HWLOC_API_VERSION</h2> |
| 65 |
|
| 66 |
<div class="memitem"> |
| 67 |
<div class="memproto"> |
| 68 |
<table class="memname"> |
| 69 |
<tr> |
| 70 |
<td class="memname">#define HWLOC_API_VERSION   0x00020c00</td> |
| 71 |
</tr> |
| 72 |
</table> |
| 73 |
</div><div class="memdoc"> |
| 74 |
|
| 75 |
<p>Indicate at build time which hwloc API version is being used. </p> |
| 76 |
<p>This number is updated to (X<<16)+(Y<<8)+Z when a new release X.Y.Z actually modifies the API.</p> |
| 77 |
<p>Users may check for available features at build time using this number (see <a class="el" href="a00386.html#faq_version_api">How do I handle API changes?</a>).</p> |
| 78 |
<dl class="section note"><dt>Note</dt><dd>This should not be confused with HWLOC_VERSION, the library version. Two stable releases of the same series usually have the same <a class="el" href="#ga8f4dfb8eef138af55dd1a0fa802e5476" title="Indicate at build time which hwloc API version is being used.">HWLOC_API_VERSION</a> even if their HWLOC_VERSION are different. </dd></dl> |
| 79 |
|
| 80 |
</div> |
| 81 |
</div> |
| 82 |
<a id="gaac5bc1f46f55e10ef0141a68ce70e21f" name="gaac5bc1f46f55e10ef0141a68ce70e21f"></a> |
| 83 |
<h2 class="memtitle"><span class="permalink"><a href="#gaac5bc1f46f55e10ef0141a68ce70e21f">◆ </a></span>HWLOC_COMPONENT_ABI</h2> |
| 84 |
|
| 85 |
<div class="memitem"> |
| 86 |
<div class="memproto"> |
| 87 |
<table class="memname"> |
| 88 |
<tr> |
| 89 |
<td class="memname">#define HWLOC_COMPONENT_ABI   7</td> |
| 90 |
</tr> |
| 91 |
</table> |
| 92 |
</div><div class="memdoc"> |
| 93 |
|
| 94 |
<p>Current component and plugin ABI version (see <a class="el" href="a00161_source.html">hwloc/plugins.h</a>). </p> |
| 95 |
|
| 96 |
</div> |
| 97 |
</div> |
| 98 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> |
| 99 |
<a id="ga9c0b50c98add1adf57ed1ce85bb5190d" name="ga9c0b50c98add1adf57ed1ce85bb5190d"></a> |
| 100 |
<h2 class="memtitle"><span class="permalink"><a href="#ga9c0b50c98add1adf57ed1ce85bb5190d">◆ </a></span>hwloc_get_api_version()</h2> |
| 101 |
|
| 102 |
<div class="memitem"> |
| 103 |
<div class="memproto"> |
| 104 |
<table class="memname"> |
| 105 |
<tr> |
| 106 |
<td class="memname">unsigned hwloc_get_api_version </td> |
| 107 |
<td>(</td> |
| 108 |
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 109 |
<td></td> |
| 110 |
</tr> |
| 111 |
</table> |
| 112 |
</div><div class="memdoc"> |
| 113 |
|
| 114 |
<p>Indicate at runtime which hwloc API version was used at build time. </p> |
| 115 |
<p>Should be <a class="el" href="#ga8f4dfb8eef138af55dd1a0fa802e5476" title="Indicate at build time which hwloc API version is being used.">HWLOC_API_VERSION</a> if running on the same version.</p> |
| 116 |
<dl class="section return"><dt>Returns</dt><dd>the build-time version number. </dd></dl> |
| 117 |
|
| 118 |
</div> |
| 119 |
</div> |
| 120 |
</div><!-- contents --> |
| 121 |
<!-- start footer part --> |
| 122 |
<hr class="footer"/><address class="footer"><small> |
| 123 |
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 |
| 124 |
</small></address> |
| 125 |
</div><!-- doc-content --> |
| 126 |
</body> |
| 127 |
</html> |