hidapi/hidapi_8h_source.html
2023-05-23 16:40:56 +00:00

292 lines
60 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hidapi: hidapi/hidapi.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">hidapi
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f69d011550147a977d318e3e9dc1c41f.html">hidapi</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">hidapi.h</div></div>
</div><!--header-->
<div class="contents">
<a href="hidapi_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*******************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> HIDAPI - Multi-Platform library for</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> communication with HID devices.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> Alan Ott</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Signal 11 Software</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"></span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> libusb/hidapi Team</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> Copyright 2023, All Rights Reserved.</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> At the discretion of the user of this library,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> this software may be licensed under the terms of the</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> GNU General Public License v3, a BSD-Style license, or the</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> original HIDAPI license as outlined in the LICENSE.txt,</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> files located at the root of the source distribution.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> These files may also be found in the public source</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> code repository located at:</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> https://github.com/libusb/hidapi .</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">********************************************************/</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifndef HIDAPI_H__</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#define HIDAPI_H__</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;wchar.h&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">/* #480: this is to be refactored properly for v1.0 */</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#ifdef _WIN32</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor"> #ifndef HID_API_NO_EXPORT_DEFINE</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor"> #define HID_API_EXPORT __declspec(dllexport)</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor"> #endif</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#ifndef HID_API_EXPORT</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13"> 39</a></span><span class="preprocessor"> #define HID_API_EXPORT </span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">/* To be removed in v1.0 */</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0"> 42</a></span><span class="preprocessor">#define HID_API_CALL </span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312"> 44</a></span><span class="preprocessor">#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL </span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="group__API.html#ga18c2d93881cb81d8bbfe6f745853ee35"> 50</a></span><span class="preprocessor">#define HID_API_VERSION_MAJOR 0</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="group__API.html#gadea0ff99909e90630d71c3083ee7e1c5"> 55</a></span><span class="preprocessor">#define HID_API_VERSION_MINOR 14</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="group__API.html#ga1d5251509ebfa4179e477c5cd79a6d23"> 60</a></span><span class="preprocessor">#define HID_API_VERSION_PATCH 0</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/* Helper macros */</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#define HID_API_AS_STR_IMPL(x) #x</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#define HID_API_AS_STR(x) HID_API_AS_STR_IMPL(x)</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#define HID_API_TO_VERSION_STR(v1, v2, v3) HID_API_AS_STR(v1.v2.v3)</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67"> 79</a></span><span class="preprocessor">#define HID_API_MAKE_VERSION(mj, mn, p) (((mj) &lt;&lt; 24) | ((mn) &lt;&lt; 8) | (p))</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="group__API.html#gade33c6fcd36510e02004311124ea2093"> 89</a></span><span class="preprocessor">#define HID_API_VERSION HID_API_MAKE_VERSION(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="group__API.html#gacba3a91088b7e54857626be97c47fdb9"> 95</a></span><span class="preprocessor">#define HID_API_VERSION_STR HID_API_TO_VERSION_STR(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="group__API.html#ga4e861f585ad041d94b142e1c2ee00b3f"> 103</a></span><span class="preprocessor">#define HID_API_MAX_REPORT_DESCRIPTOR_SIZE 4096</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="structhid__api__version.html"> 109</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structhid__api__version.html">hid_api_version</a> {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structhid__api__version.html#a57b73e2eae9c7670239442466d97f2bf"> 110</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structhid__api__version.html#a57b73e2eae9c7670239442466d97f2bf">major</a>; </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structhid__api__version.html#a5ebe257ab40c62b6c85d70811a66bcc7"> 111</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structhid__api__version.html#a5ebe257ab40c62b6c85d70811a66bcc7">minor</a>; </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structhid__api__version.html#af18ab0b7873fb676fe14605ad159e5e7"> 112</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structhid__api__version.html#af18ab0b7873fb676fe14605ad159e5e7">patch</a>; </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> };</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">struct </span>hid_device_;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc"> 116</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>hid_device_ <a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a>; </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="group__API.html#ga15cb543842973ca41daa21feaec534ce"> 122</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="group__API.html#gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e"> 124</a></span> <a class="code hl_enumvalue" href="group__API.html#gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e">HID_API_BUS_UNKNOWN</a> = 0x00,</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="group__API.html#gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d"> 129</a></span> <a class="code hl_enumvalue" href="group__API.html#gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d">HID_API_BUS_USB</a> = 0x01,</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="group__API.html#gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4"> 136</a></span> <a class="code hl_enumvalue" href="group__API.html#gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4">HID_API_BUS_BLUETOOTH</a> = 0x02,</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="group__API.html#gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0"> 141</a></span> <a class="code hl_enumvalue" href="group__API.html#gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0">HID_API_BUS_I2C</a> = 0x03,</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"><a class="line" href="group__API.html#gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38"> 146</a></span> <a class="code hl_enumvalue" href="group__API.html#gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38">HID_API_BUS_SPI</a> = 0x04,</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> } <a class="code hl_enumeration" href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a>;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="structhid__device__info.html"> 150</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structhid__device__info.html">hid_device_info</a> {</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a6384b5bf4d9583598e5f5a889f240921"> 152</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structhid__device__info.html#a6384b5bf4d9583598e5f5a889f240921">path</a>;</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a5037a3914e0bd8a3f821d1be9376c709"> 154</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a5037a3914e0bd8a3f821d1be9376c709">vendor_id</a>;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a04595915457b4374492edb1fdb62d65d"> 156</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a04595915457b4374492edb1fdb62d65d">product_id</a>;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a80756cea367e1566f966438984b75faf"> 158</a></span> <span class="keywordtype">wchar_t</span> *<a class="code hl_variable" href="structhid__device__info.html#a80756cea367e1566f966438984b75faf">serial_number</a>;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a6a832d25260f7ec17ef008e53e50e1d0"> 161</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a6a832d25260f7ec17ef008e53e50e1d0">release_number</a>;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a484eebf746220cd2910954cc861759b7"> 163</a></span> <span class="keywordtype">wchar_t</span> *<a class="code hl_variable" href="structhid__device__info.html#a484eebf746220cd2910954cc861759b7">manufacturer_string</a>;</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="structhid__device__info.html#aceee256b4f7cd7fdd9fa5d556f49d221"> 165</a></span> <span class="keywordtype">wchar_t</span> *<a class="code hl_variable" href="structhid__device__info.html#aceee256b4f7cd7fdd9fa5d556f49d221">product_string</a>;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="structhid__device__info.html#ab811117f8084ce2036815bdd33b16b3b"> 168</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#ab811117f8084ce2036815bdd33b16b3b">usage_page</a>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a47f8011d58bcddd67f1403d6d3b4cab6"> 171</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a47f8011d58bcddd67f1403d6d3b4cab6">usage</a>;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a9163d8d5d7db8dc47bddfaf876e17547"> 178</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structhid__device__info.html#a9163d8d5d7db8dc47bddfaf876e17547">interface_number</a>;</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"><a class="line" href="structhid__device__info.html#a2bfebc240baf3bdaf03965816e11f149"> 181</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structhid__device__info.html">hid_device_info</a> *<a class="code hl_variable" href="structhid__device__info.html#a2bfebc240baf3bdaf03965816e11f149">next</a>;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="structhid__device__info.html#afa3c7d42a0892d9f1f25976709cf5aa2"> 186</a></span> <a class="code hl_enumeration" href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a> <a class="code hl_variable" href="structhid__device__info.html#afa3c7d42a0892d9f1f25976709cf5aa2">bus_type</a>;</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> };</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> </div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"><a class="line" href="group__API.html#ga142ffc1b0b7a7fa412d3862b2a17164b"> 205</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga142ffc1b0b7a7fa412d3862b2a17164b">hid_init</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"><a class="line" href="group__API.html#gacf5da9ce37132eba69fc259f17f13023"> 218</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gacf5da9ce37132eba69fc259f17f13023">hid_exit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"><a class="line" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d"> 245</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structhid__device__info.html">hid_device_info</a> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> * <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d">hid_enumerate</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a5037a3914e0bd8a3f821d1be9376c709">vendor_id</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a04595915457b4374492edb1fdb62d65d">product_id</a>);</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"><a class="line" href="group__API.html#gafc2d2adf71db3784b783b9a554527aa4"> 255</a></span> <span class="keywordtype">void</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gafc2d2adf71db3784b783b9a554527aa4">hid_free_enumeration</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structhid__device__info.html">hid_device_info</a> *devs);</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"><a class="line" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede"> 277</a></span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> * <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede">hid_open</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a5037a3914e0bd8a3f821d1be9376c709">vendor_id</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code hl_variable" href="structhid__device__info.html#a04595915457b4374492edb1fdb62d65d">product_id</a>, <span class="keyword">const</span> <span class="keywordtype">wchar_t</span> *<a class="code hl_variable" href="structhid__device__info.html#a80756cea367e1566f966438984b75faf">serial_number</a>);</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"><a class="line" href="group__API.html#ga954ecb58b5dfb4a6ef6be3dcd520e42f"> 296</a></span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> * <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga954ecb58b5dfb4a6ef6be3dcd520e42f">hid_open_path</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structhid__device__info.html#a6384b5bf4d9583598e5f5a889f240921">path</a>);</div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span> </div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"><a class="line" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d"> 325</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d">hid_write</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> </div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno"><a class="line" href="group__API.html#gaa5c9ed5aa290688ffac03343989ad75a"> 348</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gaa5c9ed5aa290688ffac03343989ad75a">hid_read_timeout</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> milliseconds);</div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno"> 349</span> </div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno"><a class="line" href="group__API.html#ga2224269e8cd7c789f9fd4864a73f8c95"> 370</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga2224269e8cd7c789f9fd4864a73f8c95">hid_read</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span> </div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno"><a class="line" href="group__API.html#ga0e9af0d8ed72f5610e9297c90b08e242"> 391</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga0e9af0d8ed72f5610e9297c90b08e242">hid_set_nonblocking</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">int</span> nonblock);</div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno"> 392</span> </div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno"><a class="line" href="group__API.html#gae99a9ddbb5d9b03fddf40fb4a492cbec"> 420</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gae99a9ddbb5d9b03fddf40fb4a492cbec">hid_send_feature_report</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno"> 421</span> </div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"><a class="line" href="group__API.html#gaa537a4b3c49d638c6ec9dedc08c44601"> 446</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gaa537a4b3c49d638c6ec9dedc08c44601">hid_get_feature_report</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> </div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno"><a class="line" href="group__API.html#ga27ac7d92ea3a8ac58b1d8d865bd0264b"> 474</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga27ac7d92ea3a8ac58b1d8d865bd0264b">hid_get_input_report</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno"> 475</span> </div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno"><a class="line" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec"> 481</a></span> <span class="keywordtype">void</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec">hid_close</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev);</div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno"> 482</span> </div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno"><a class="line" href="group__API.html#ga702f45b42d85599eedd602c05661fde5"> 494</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> <a class="code hl_function" href="group__API.html#ga702f45b42d85599eedd602c05661fde5">hid_get_manufacturer_string</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">wchar_t</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> maxlen);</div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno"> 495</span> </div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno"><a class="line" href="group__API.html#ga648feb765c5e0da3e821ee84aeab9d99"> 507</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> <a class="code hl_function" href="group__API.html#ga648feb765c5e0da3e821ee84aeab9d99">hid_get_product_string</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">wchar_t</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> maxlen);</div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno"> 508</span> </div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno"><a class="line" href="group__API.html#ga3442db3ece59fe248b0625a4c8fca617"> 520</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> <a class="code hl_function" href="group__API.html#ga3442db3ece59fe248b0625a4c8fca617">hid_get_serial_number_string</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">wchar_t</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> maxlen);</div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno"> 521</span> </div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno"><a class="line" href="group__API.html#ga2d8b34ae8cfdd4f4d132814d5b70c128"> 537</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structhid__device__info.html">hid_device_info</a> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> * <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#ga2d8b34ae8cfdd4f4d132814d5b70c128">hid_get_device_info</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev);</div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno"> 538</span> </div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno"><a class="line" href="group__API.html#ga18546669554746d0f292ca5e23372e06"> 551</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> <a class="code hl_function" href="group__API.html#ga18546669554746d0f292ca5e23372e06">hid_get_indexed_string</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">int</span> string_index, <span class="keywordtype">wchar_t</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> maxlen);</div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno"> 552</span> </div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno"><a class="line" href="group__API.html#gaaa8bc561909c1c6b413f1fcdc16333ef"> 568</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> <a class="code hl_function" href="group__API.html#gaaa8bc561909c1c6b413f1fcdc16333ef">hid_get_report_descriptor</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> buf_size);</div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno"> 569</span> </div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno"><a class="line" href="group__API.html#gabdb1e88a803bab198333a3c5f131b12e"> 595</a></span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gabdb1e88a803bab198333a3c5f131b12e">hid_error</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev);</div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno"> 596</span> </div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno"><a class="line" href="group__API.html#gaea589e58403a465361a347c0754a3da2"> 606</a></span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="structhid__api__version.html">hid_api_version</a>* <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gaea589e58403a465361a347c0754a3da2">hid_version</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno"> 607</span> </div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno"> 608</span> </div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno"><a class="line" href="group__API.html#gacbceccb9fd443fd7cb164dee029fbf64"> 618</a></span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="group__API.html#gacbceccb9fd443fd7cb164dee029fbf64">hid_version_str</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno"> 619</span> </div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno"><a class="line" href="hidapi_8h.html#af29a5c16b4afdef33e8d229afcca6897"> 623</a></span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="code hl_define" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> <a class="code hl_function" href="hidapi_8h.html#af29a5c16b4afdef33e8d229afcca6897">hid_write_control</a>(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *device, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno"> 624</span> </div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno"> 625</span><span class="preprocessor">#ifdef __APPLE__</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno"> 630</span> <span class="keywordtype">int</span> <a class="code hl_define" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> hid_init_sixaxis_usb(<a class="code hl_typedef" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev);</div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno"> 631</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno"> 632</span> </div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno"> 633</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno"> 634</span>}</div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno"> 635</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno"> 636</span> </div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno"> 637</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="agroup__API_html_ga0e9af0d8ed72f5610e9297c90b08e242"><div class="ttname"><a href="group__API.html#ga0e9af0d8ed72f5610e9297c90b08e242">hid_set_nonblocking</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock)</div><div class="ttdoc">Set the device handle to be non-blocking.</div></div>
<div class="ttc" id="agroup__API_html_ga142ffc1b0b7a7fa412d3862b2a17164b"><div class="ttname"><a href="group__API.html#ga142ffc1b0b7a7fa412d3862b2a17164b">hid_init</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_init(void)</div><div class="ttdoc">Initialize the HIDAPI library.</div></div>
<div class="ttc" id="agroup__API_html_ga15cb543842973ca41daa21feaec534ce"><div class="ttname"><a href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a></div><div class="ttdeci">hid_bus_type</div><div class="ttdoc">HID underlying bus types.</div><div class="ttdef"><b>Definition:</b> hidapi.h:122</div></div>
<div class="ttc" id="agroup__API_html_ga18546669554746d0f292ca5e23372e06"><div class="ttname"><a href="group__API.html#ga18546669554746d0f292ca5e23372e06">hid_get_indexed_string</a></div><div class="ttdeci">int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen)</div><div class="ttdoc">Get a string from a HID device, based on its string index.</div></div>
<div class="ttc" id="agroup__API_html_ga2224269e8cd7c789f9fd4864a73f8c95"><div class="ttname"><a href="group__API.html#ga2224269e8cd7c789f9fd4864a73f8c95">hid_read</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length)</div><div class="ttdoc">Read an Input report from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga27ac7d92ea3a8ac58b1d8d865bd0264b"><div class="ttname"><a href="group__API.html#ga27ac7d92ea3a8ac58b1d8d865bd0264b">hid_get_input_report</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length)</div><div class="ttdoc">Get a input report from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga2d8b34ae8cfdd4f4d132814d5b70c128"><div class="ttname"><a href="group__API.html#ga2d8b34ae8cfdd4f4d132814d5b70c128">hid_get_device_info</a></div><div class="ttdeci">struct hid_device_info HID_API_EXPORT *HID_API_CALL hid_get_device_info(hid_device *dev)</div><div class="ttdoc">Get The struct hid_device_info from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga3442db3ece59fe248b0625a4c8fca617"><div class="ttname"><a href="group__API.html#ga3442db3ece59fe248b0625a4c8fca617">hid_get_serial_number_string</a></div><div class="ttdeci">int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen)</div><div class="ttdoc">Get The Serial Number String from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga648feb765c5e0da3e821ee84aeab9d99"><div class="ttname"><a href="group__API.html#ga648feb765c5e0da3e821ee84aeab9d99">hid_get_product_string</a></div><div class="ttdeci">int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen)</div><div class="ttdoc">Get The Product String from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga6946f7e2f5d225d69308611db1e31ede"><div class="ttname"><a href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede">hid_open</a></div><div class="ttdeci">HID_API_EXPORT hid_device *HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number)</div><div class="ttdoc">Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.</div></div>
<div class="ttc" id="agroup__API_html_ga702f45b42d85599eedd602c05661fde5"><div class="ttname"><a href="group__API.html#ga702f45b42d85599eedd602c05661fde5">hid_get_manufacturer_string</a></div><div class="ttdeci">int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen)</div><div class="ttdoc">Get The Manufacturer String from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga8d478a5986439ffb838fb1f1ba6ba5ec"><div class="ttname"><a href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec">hid_close</a></div><div class="ttdeci">void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev)</div><div class="ttdoc">Close a HID device.</div></div>
<div class="ttc" id="agroup__API_html_ga954ecb58b5dfb4a6ef6be3dcd520e42f"><div class="ttname"><a href="group__API.html#ga954ecb58b5dfb4a6ef6be3dcd520e42f">hid_open_path</a></div><div class="ttdeci">HID_API_EXPORT hid_device *HID_API_CALL hid_open_path(const char *path)</div><div class="ttdoc">Open a HID device by its path name.</div></div>
<div class="ttc" id="agroup__API_html_gaa537a4b3c49d638c6ec9dedc08c44601"><div class="ttname"><a href="group__API.html#gaa537a4b3c49d638c6ec9dedc08c44601">hid_get_feature_report</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length)</div><div class="ttdoc">Get a feature report from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_gaa5c9ed5aa290688ffac03343989ad75a"><div class="ttname"><a href="group__API.html#gaa5c9ed5aa290688ffac03343989ad75a">hid_read_timeout</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds)</div><div class="ttdoc">Read an Input report from a HID device with timeout.</div></div>
<div class="ttc" id="agroup__API_html_gaa691d2c469b9654128196bf7ef8edd9d"><div class="ttname"><a href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d">hid_write</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length)</div><div class="ttdoc">Write an Output report to a HID device.</div></div>
<div class="ttc" id="agroup__API_html_gaaa8bc561909c1c6b413f1fcdc16333ef"><div class="ttname"><a href="group__API.html#gaaa8bc561909c1c6b413f1fcdc16333ef">hid_get_report_descriptor</a></div><div class="ttdeci">int HID_API_EXPORT_CALL hid_get_report_descriptor(hid_device *dev, unsigned char *buf, size_t buf_size)</div><div class="ttdoc">Get a report descriptor from a HID device.</div></div>
<div class="ttc" id="agroup__API_html_gaae7d1c3e90835556ddc73fabe3a9ca9d"><div class="ttname"><a href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d">hid_enumerate</a></div><div class="ttdeci">struct hid_device_info HID_API_EXPORT *HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id)</div><div class="ttdoc">Enumerate the HID Devices.</div></div>
<div class="ttc" id="agroup__API_html_gabdb1e88a803bab198333a3c5f131b12e"><div class="ttname"><a href="group__API.html#gabdb1e88a803bab198333a3c5f131b12e">hid_error</a></div><div class="ttdeci">HID_API_EXPORT const wchar_t *HID_API_CALL hid_error(hid_device *dev)</div><div class="ttdoc">Get a string describing the last error which occurred.</div></div>
<div class="ttc" id="agroup__API_html_gacbceccb9fd443fd7cb164dee029fbf64"><div class="ttname"><a href="group__API.html#gacbceccb9fd443fd7cb164dee029fbf64">hid_version_str</a></div><div class="ttdeci">HID_API_EXPORT const char *HID_API_CALL hid_version_str(void)</div><div class="ttdoc">Get a runtime version string of the library.</div></div>
<div class="ttc" id="agroup__API_html_gacf5da9ce37132eba69fc259f17f13023"><div class="ttname"><a href="group__API.html#gacf5da9ce37132eba69fc259f17f13023">hid_exit</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_exit(void)</div><div class="ttdoc">Finalize the HIDAPI library.</div></div>
<div class="ttc" id="agroup__API_html_gae99a9ddbb5d9b03fddf40fb4a492cbec"><div class="ttname"><a href="group__API.html#gae99a9ddbb5d9b03fddf40fb4a492cbec">hid_send_feature_report</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length)</div><div class="ttdoc">Send a Feature report to the device.</div></div>
<div class="ttc" id="agroup__API_html_gaea589e58403a465361a347c0754a3da2"><div class="ttname"><a href="group__API.html#gaea589e58403a465361a347c0754a3da2">hid_version</a></div><div class="ttdeci">HID_API_EXPORT const struct hid_api_version *HID_API_CALL hid_version(void)</div><div class="ttdoc">Get a runtime version of the library.</div></div>
<div class="ttc" id="agroup__API_html_gafc2d2adf71db3784b783b9a554527aa4"><div class="ttname"><a href="group__API.html#gafc2d2adf71db3784b783b9a554527aa4">hid_free_enumeration</a></div><div class="ttdeci">void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs)</div><div class="ttdoc">Free an enumeration Linked List.</div></div>
<div class="ttc" id="agroup__API_html_gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38"><div class="ttname"><a href="group__API.html#gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38">HID_API_BUS_SPI</a></div><div class="ttdeci">@ HID_API_BUS_SPI</div><div class="ttdef"><b>Definition:</b> hidapi.h:146</div></div>
<div class="ttc" id="agroup__API_html_gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d"><div class="ttname"><a href="group__API.html#gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d">HID_API_BUS_USB</a></div><div class="ttdeci">@ HID_API_BUS_USB</div><div class="ttdef"><b>Definition:</b> hidapi.h:129</div></div>
<div class="ttc" id="agroup__API_html_gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e"><div class="ttname"><a href="group__API.html#gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e">HID_API_BUS_UNKNOWN</a></div><div class="ttdeci">@ HID_API_BUS_UNKNOWN</div><div class="ttdef"><b>Definition:</b> hidapi.h:124</div></div>
<div class="ttc" id="agroup__API_html_gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4"><div class="ttname"><a href="group__API.html#gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4">HID_API_BUS_BLUETOOTH</a></div><div class="ttdeci">@ HID_API_BUS_BLUETOOTH</div><div class="ttdef"><b>Definition:</b> hidapi.h:136</div></div>
<div class="ttc" id="agroup__API_html_gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0"><div class="ttname"><a href="group__API.html#gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0">HID_API_BUS_I2C</a></div><div class="ttdeci">@ HID_API_BUS_I2C</div><div class="ttdef"><b>Definition:</b> hidapi.h:141</div></div>
<div class="ttc" id="ahidapi_8h_html_a70c49eda5025c1bc455af77da19ca312"><div class="ttname"><a href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a></div><div class="ttdeci">#define HID_API_EXPORT_CALL</div><div class="ttdef"><b>Definition:</b> hidapi.h:44</div></div>
<div class="ttc" id="ahidapi_8h_html_aa60150016800ccb88fdf140e8553ae13"><div class="ttname"><a href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a></div><div class="ttdeci">#define HID_API_EXPORT</div><div class="ttdef"><b>Definition:</b> hidapi.h:39</div></div>
<div class="ttc" id="ahidapi_8h_html_aa6da74d5686d198dd3e5440e60088fcc"><div class="ttname"><a href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a></div><div class="ttdeci">struct hid_device_ hid_device</div><div class="ttdef"><b>Definition:</b> hidapi.h:116</div></div>
<div class="ttc" id="ahidapi_8h_html_af140a25716604e86096670a505a58ee0"><div class="ttname"><a href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a></div><div class="ttdeci">#define HID_API_CALL</div><div class="ttdef"><b>Definition:</b> hidapi.h:42</div></div>
<div class="ttc" id="ahidapi_8h_html_af29a5c16b4afdef33e8d229afcca6897"><div class="ttname"><a href="hidapi_8h.html#af29a5c16b4afdef33e8d229afcca6897">hid_write_control</a></div><div class="ttdeci">int HID_API_EXPORT HID_API_CALL hid_write_control(hid_device *device, const unsigned char *data, size_t length)</div></div>
<div class="ttc" id="astructhid__api__version_html"><div class="ttname"><a href="structhid__api__version.html">hid_api_version</a></div><div class="ttdef"><b>Definition:</b> hidapi.h:109</div></div>
<div class="ttc" id="astructhid__api__version_html_a57b73e2eae9c7670239442466d97f2bf"><div class="ttname"><a href="structhid__api__version.html#a57b73e2eae9c7670239442466d97f2bf">hid_api_version::major</a></div><div class="ttdeci">int major</div><div class="ttdef"><b>Definition:</b> hidapi.h:110</div></div>
<div class="ttc" id="astructhid__api__version_html_a5ebe257ab40c62b6c85d70811a66bcc7"><div class="ttname"><a href="structhid__api__version.html#a5ebe257ab40c62b6c85d70811a66bcc7">hid_api_version::minor</a></div><div class="ttdeci">int minor</div><div class="ttdef"><b>Definition:</b> hidapi.h:111</div></div>
<div class="ttc" id="astructhid__api__version_html_af18ab0b7873fb676fe14605ad159e5e7"><div class="ttname"><a href="structhid__api__version.html#af18ab0b7873fb676fe14605ad159e5e7">hid_api_version::patch</a></div><div class="ttdeci">int patch</div><div class="ttdef"><b>Definition:</b> hidapi.h:112</div></div>
<div class="ttc" id="astructhid__device__info_html"><div class="ttname"><a href="structhid__device__info.html">hid_device_info</a></div><div class="ttdef"><b>Definition:</b> hidapi.h:150</div></div>
<div class="ttc" id="astructhid__device__info_html_a04595915457b4374492edb1fdb62d65d"><div class="ttname"><a href="structhid__device__info.html#a04595915457b4374492edb1fdb62d65d">hid_device_info::product_id</a></div><div class="ttdeci">unsigned short product_id</div><div class="ttdef"><b>Definition:</b> hidapi.h:156</div></div>
<div class="ttc" id="astructhid__device__info_html_a2bfebc240baf3bdaf03965816e11f149"><div class="ttname"><a href="structhid__device__info.html#a2bfebc240baf3bdaf03965816e11f149">hid_device_info::next</a></div><div class="ttdeci">struct hid_device_info * next</div><div class="ttdef"><b>Definition:</b> hidapi.h:181</div></div>
<div class="ttc" id="astructhid__device__info_html_a47f8011d58bcddd67f1403d6d3b4cab6"><div class="ttname"><a href="structhid__device__info.html#a47f8011d58bcddd67f1403d6d3b4cab6">hid_device_info::usage</a></div><div class="ttdeci">unsigned short usage</div><div class="ttdef"><b>Definition:</b> hidapi.h:171</div></div>
<div class="ttc" id="astructhid__device__info_html_a484eebf746220cd2910954cc861759b7"><div class="ttname"><a href="structhid__device__info.html#a484eebf746220cd2910954cc861759b7">hid_device_info::manufacturer_string</a></div><div class="ttdeci">wchar_t * manufacturer_string</div><div class="ttdef"><b>Definition:</b> hidapi.h:163</div></div>
<div class="ttc" id="astructhid__device__info_html_a5037a3914e0bd8a3f821d1be9376c709"><div class="ttname"><a href="structhid__device__info.html#a5037a3914e0bd8a3f821d1be9376c709">hid_device_info::vendor_id</a></div><div class="ttdeci">unsigned short vendor_id</div><div class="ttdef"><b>Definition:</b> hidapi.h:154</div></div>
<div class="ttc" id="astructhid__device__info_html_a6384b5bf4d9583598e5f5a889f240921"><div class="ttname"><a href="structhid__device__info.html#a6384b5bf4d9583598e5f5a889f240921">hid_device_info::path</a></div><div class="ttdeci">char * path</div><div class="ttdef"><b>Definition:</b> hidapi.h:152</div></div>
<div class="ttc" id="astructhid__device__info_html_a6a832d25260f7ec17ef008e53e50e1d0"><div class="ttname"><a href="structhid__device__info.html#a6a832d25260f7ec17ef008e53e50e1d0">hid_device_info::release_number</a></div><div class="ttdeci">unsigned short release_number</div><div class="ttdef"><b>Definition:</b> hidapi.h:161</div></div>
<div class="ttc" id="astructhid__device__info_html_a80756cea367e1566f966438984b75faf"><div class="ttname"><a href="structhid__device__info.html#a80756cea367e1566f966438984b75faf">hid_device_info::serial_number</a></div><div class="ttdeci">wchar_t * serial_number</div><div class="ttdef"><b>Definition:</b> hidapi.h:158</div></div>
<div class="ttc" id="astructhid__device__info_html_a9163d8d5d7db8dc47bddfaf876e17547"><div class="ttname"><a href="structhid__device__info.html#a9163d8d5d7db8dc47bddfaf876e17547">hid_device_info::interface_number</a></div><div class="ttdeci">int interface_number</div><div class="ttdef"><b>Definition:</b> hidapi.h:178</div></div>
<div class="ttc" id="astructhid__device__info_html_ab811117f8084ce2036815bdd33b16b3b"><div class="ttname"><a href="structhid__device__info.html#ab811117f8084ce2036815bdd33b16b3b">hid_device_info::usage_page</a></div><div class="ttdeci">unsigned short usage_page</div><div class="ttdef"><b>Definition:</b> hidapi.h:168</div></div>
<div class="ttc" id="astructhid__device__info_html_aceee256b4f7cd7fdd9fa5d556f49d221"><div class="ttname"><a href="structhid__device__info.html#aceee256b4f7cd7fdd9fa5d556f49d221">hid_device_info::product_string</a></div><div class="ttdeci">wchar_t * product_string</div><div class="ttdef"><b>Definition:</b> hidapi.h:165</div></div>
<div class="ttc" id="astructhid__device__info_html_afa3c7d42a0892d9f1f25976709cf5aa2"><div class="ttname"><a href="structhid__device__info.html#afa3c7d42a0892d9f1f25976709cf5aa2">hid_device_info::bus_type</a></div><div class="ttdeci">hid_bus_type bus_type</div><div class="ttdef"><b>Definition:</b> hidapi.h:186</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 23 2023 16:40:38 for hidapi by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>