RPCS3/archived-hidapi
1
0
Fork 0
mirror of https://github.com/RPCS3/hidapi.git synced 2026-01-31 01:25:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
archived-hidapi/group__API.html
Megamouse bee9f60fb0 deploy: f42423643e
2025-05-23 01:21:43 +00:00

1330 lines
95 KiB
HTML
Raw Permalink Blame History

<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hidapi: hidapi API</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.8 -->
<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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">hidapi API</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga18c2d93881cb81d8bbfe6f745853ee35" id="r_ga18c2d93881cb81d8bbfe6f745853ee35"><td class="memItemLeft" align="right" valign="top"><a id="ga18c2d93881cb81d8bbfe6f745853ee35" name="ga18c2d93881cb81d8bbfe6f745853ee35"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HID_API_VERSION_MAJOR</b>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ga18c2d93881cb81d8bbfe6f745853ee35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static/compile-time major version of the library. <br /></td></tr>
<tr class="separator:ga18c2d93881cb81d8bbfe6f745853ee35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadea0ff99909e90630d71c3083ee7e1c5" id="r_gadea0ff99909e90630d71c3083ee7e1c5"><td class="memItemLeft" align="right" valign="top"><a id="gadea0ff99909e90630d71c3083ee7e1c5" name="gadea0ff99909e90630d71c3083ee7e1c5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HID_API_VERSION_MINOR</b>&#160;&#160;&#160;15</td></tr>
<tr class="memdesc:gadea0ff99909e90630d71c3083ee7e1c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static/compile-time minor version of the library. <br /></td></tr>
<tr class="separator:gadea0ff99909e90630d71c3083ee7e1c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d5251509ebfa4179e477c5cd79a6d23" id="r_ga1d5251509ebfa4179e477c5cd79a6d23"><td class="memItemLeft" align="right" valign="top"><a id="ga1d5251509ebfa4179e477c5cd79a6d23" name="ga1d5251509ebfa4179e477c5cd79a6d23"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HID_API_VERSION_PATCH</b>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ga1d5251509ebfa4179e477c5cd79a6d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static/compile-time patch version of the library. <br /></td></tr>
<tr class="separator:ga1d5251509ebfa4179e477c5cd79a6d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf415391c655f68807580fe3fb8f7ba67" id="r_gaf415391c655f68807580fe3fb8f7ba67"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67">HID_API_MAKE_VERSION</a>(mj, mn, p)&#160;&#160;&#160;(((mj) &lt;&lt; 24) | ((mn) &lt;&lt; 8) | (p))</td></tr>
<tr class="memdesc:gaf415391c655f68807580fe3fb8f7ba67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;. <br /></td></tr>
<tr class="separator:gaf415391c655f68807580fe3fb8f7ba67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade33c6fcd36510e02004311124ea2093" id="r_gade33c6fcd36510e02004311124ea2093"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a>&#160;&#160;&#160;<a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67">HID_API_MAKE_VERSION</a>(<a class="el" href="group__API.html#ga18c2d93881cb81d8bbfe6f745853ee35">HID_API_VERSION_MAJOR</a>, <a class="el" href="group__API.html#gadea0ff99909e90630d71c3083ee7e1c5">HID_API_VERSION_MINOR</a>, <a class="el" href="group__API.html#ga1d5251509ebfa4179e477c5cd79a6d23">HID_API_VERSION_PATCH</a>)</td></tr>
<tr class="memdesc:gade33c6fcd36510e02004311124ea2093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static/compile-time version of the library. <br /></td></tr>
<tr class="separator:gade33c6fcd36510e02004311124ea2093"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacba3a91088b7e54857626be97c47fdb9" id="r_gacba3a91088b7e54857626be97c47fdb9"><td class="memItemLeft" align="right" valign="top"><a id="gacba3a91088b7e54857626be97c47fdb9" name="gacba3a91088b7e54857626be97c47fdb9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HID_API_VERSION_STR</b>&#160;&#160;&#160;HID_API_TO_VERSION_STR(<a class="el" href="group__API.html#ga18c2d93881cb81d8bbfe6f745853ee35">HID_API_VERSION_MAJOR</a>, <a class="el" href="group__API.html#gadea0ff99909e90630d71c3083ee7e1c5">HID_API_VERSION_MINOR</a>, <a class="el" href="group__API.html#ga1d5251509ebfa4179e477c5cd79a6d23">HID_API_VERSION_PATCH</a>)</td></tr>
<tr class="memdesc:gacba3a91088b7e54857626be97c47fdb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static/compile-time string version of the library. <br /></td></tr>
<tr class="separator:gacba3a91088b7e54857626be97c47fdb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e861f585ad041d94b142e1c2ee00b3f" id="r_ga4e861f585ad041d94b142e1c2ee00b3f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga4e861f585ad041d94b142e1c2ee00b3f">HID_API_MAX_REPORT_DESCRIPTOR_SIZE</a>&#160;&#160;&#160;4096</td></tr>
<tr class="memdesc:ga4e861f585ad041d94b142e1c2ee00b3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum expected HID Report descriptor size in bytes. <br /></td></tr>
<tr class="separator:ga4e861f585ad041d94b142e1c2ee00b3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga15cb543842973ca41daa21feaec534ce" id="r_ga15cb543842973ca41daa21feaec534ce"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a> { <br />
&#160;&#160;<a class="el" href="group__API.html#gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e">HID_API_BUS_UNKNOWN</a> = 0x00
, <a class="el" href="group__API.html#gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d">HID_API_BUS_USB</a> = 0x01
, <a class="el" href="group__API.html#gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4">HID_API_BUS_BLUETOOTH</a> = 0x02
, <a class="el" href="group__API.html#gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0">HID_API_BUS_I2C</a> = 0x03
, <br />
&#160;&#160;<a class="el" href="group__API.html#gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38">HID_API_BUS_SPI</a> = 0x04
<br />
}</td></tr>
<tr class="memdesc:ga15cb543842973ca41daa21feaec534ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">HID underlying bus types. <a href="group__API.html#ga15cb543842973ca41daa21feaec534ce">More...</a><br /></td></tr>
<tr class="separator:ga15cb543842973ca41daa21feaec534ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga142ffc1b0b7a7fa412d3862b2a17164b" id="r_ga142ffc1b0b7a7fa412d3862b2a17164b"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga142ffc1b0b7a7fa412d3862b2a17164b">hid_init</a> (void)</td></tr>
<tr class="memdesc:ga142ffc1b0b7a7fa412d3862b2a17164b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the HIDAPI library. <br /></td></tr>
<tr class="separator:ga142ffc1b0b7a7fa412d3862b2a17164b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf5da9ce37132eba69fc259f17f13023" id="r_gacf5da9ce37132eba69fc259f17f13023"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gacf5da9ce37132eba69fc259f17f13023">hid_exit</a> (void)</td></tr>
<tr class="memdesc:gacf5da9ce37132eba69fc259f17f13023"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalize the HIDAPI library. <br /></td></tr>
<tr class="separator:gacf5da9ce37132eba69fc259f17f13023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae7d1c3e90835556ddc73fabe3a9ca9d" id="r_gaae7d1c3e90835556ddc73fabe3a9ca9d"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structhid__device__info.html">hid_device_info</a> <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d">hid_enumerate</a> (unsigned short vendor_id, unsigned short product_id)</td></tr>
<tr class="memdesc:gaae7d1c3e90835556ddc73fabe3a9ca9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumerate the HID Devices. <br /></td></tr>
<tr class="separator:gaae7d1c3e90835556ddc73fabe3a9ca9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc2d2adf71db3784b783b9a554527aa4" id="r_gafc2d2adf71db3784b783b9a554527aa4"><td class="memItemLeft" align="right" valign="top">void <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gafc2d2adf71db3784b783b9a554527aa4">hid_free_enumeration</a> (struct <a class="el" href="structhid__device__info.html">hid_device_info</a> *devs)</td></tr>
<tr class="memdesc:gafc2d2adf71db3784b783b9a554527aa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an enumeration Linked List. <br /></td></tr>
<tr class="separator:gafc2d2adf71db3784b783b9a554527aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6946f7e2f5d225d69308611db1e31ede" id="r_ga6946f7e2f5d225d69308611db1e31ede"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede">hid_open</a> (unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number)</td></tr>
<tr class="memdesc:ga6946f7e2f5d225d69308611db1e31ede"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number. <br /></td></tr>
<tr class="separator:ga6946f7e2f5d225d69308611db1e31ede"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga954ecb58b5dfb4a6ef6be3dcd520e42f" id="r_ga954ecb58b5dfb4a6ef6be3dcd520e42f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga954ecb58b5dfb4a6ef6be3dcd520e42f">hid_open_path</a> (const char *path)</td></tr>
<tr class="memdesc:ga954ecb58b5dfb4a6ef6be3dcd520e42f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a HID device by its path name. <br /></td></tr>
<tr class="separator:ga954ecb58b5dfb4a6ef6be3dcd520e42f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa691d2c469b9654128196bf7ef8edd9d" id="r_gaa691d2c469b9654128196bf7ef8edd9d"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d">hid_write</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, const unsigned char *data, size_t length)</td></tr>
<tr class="memdesc:gaa691d2c469b9654128196bf7ef8edd9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write an Output report to a HID device. <br /></td></tr>
<tr class="separator:gaa691d2c469b9654128196bf7ef8edd9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5c9ed5aa290688ffac03343989ad75a" id="r_gaa5c9ed5aa290688ffac03343989ad75a"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaa5c9ed5aa290688ffac03343989ad75a">hid_read_timeout</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, unsigned char *data, size_t length, int milliseconds)</td></tr>
<tr class="memdesc:gaa5c9ed5aa290688ffac03343989ad75a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an Input report from a HID device with timeout. <br /></td></tr>
<tr class="separator:gaa5c9ed5aa290688ffac03343989ad75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2224269e8cd7c789f9fd4864a73f8c95" id="r_ga2224269e8cd7c789f9fd4864a73f8c95"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga2224269e8cd7c789f9fd4864a73f8c95">hid_read</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, unsigned char *data, size_t length)</td></tr>
<tr class="memdesc:ga2224269e8cd7c789f9fd4864a73f8c95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an Input report from a HID device. <br /></td></tr>
<tr class="separator:ga2224269e8cd7c789f9fd4864a73f8c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d7137c63986df36560e39289e4928e1" id="r_ga5d7137c63986df36560e39289e4928e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const wchar_t *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga5d7137c63986df36560e39289e4928e1">hid_read_error</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev)</td></tr>
<tr class="memdesc:ga5d7137c63986df36560e39289e4928e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string describing the last error which occurred during hid_read/hid_read_timeout. <br /></td></tr>
<tr class="separator:ga5d7137c63986df36560e39289e4928e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0e9af0d8ed72f5610e9297c90b08e242" id="r_ga0e9af0d8ed72f5610e9297c90b08e242"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga0e9af0d8ed72f5610e9297c90b08e242">hid_set_nonblocking</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, int nonblock)</td></tr>
<tr class="memdesc:ga0e9af0d8ed72f5610e9297c90b08e242"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the device handle to be non-blocking. <br /></td></tr>
<tr class="separator:ga0e9af0d8ed72f5610e9297c90b08e242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae99a9ddbb5d9b03fddf40fb4a492cbec" id="r_gae99a9ddbb5d9b03fddf40fb4a492cbec"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gae99a9ddbb5d9b03fddf40fb4a492cbec">hid_send_feature_report</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, const unsigned char *data, size_t length)</td></tr>
<tr class="memdesc:gae99a9ddbb5d9b03fddf40fb4a492cbec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a Feature report to the device. <br /></td></tr>
<tr class="separator:gae99a9ddbb5d9b03fddf40fb4a492cbec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa537a4b3c49d638c6ec9dedc08c44601" id="r_gaa537a4b3c49d638c6ec9dedc08c44601"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaa537a4b3c49d638c6ec9dedc08c44601">hid_get_feature_report</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, unsigned char *data, size_t length)</td></tr>
<tr class="memdesc:gaa537a4b3c49d638c6ec9dedc08c44601"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a feature report from a HID device. <br /></td></tr>
<tr class="separator:gaa537a4b3c49d638c6ec9dedc08c44601"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f18ce9abffb0a9e7b1b5bac0e39376f" id="r_ga6f18ce9abffb0a9e7b1b5bac0e39376f"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga6f18ce9abffb0a9e7b1b5bac0e39376f">hid_send_output_report</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, const unsigned char *data, size_t length)</td></tr>
<tr class="memdesc:ga6f18ce9abffb0a9e7b1b5bac0e39376f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a Output report to the device. <br /></td></tr>
<tr class="separator:ga6f18ce9abffb0a9e7b1b5bac0e39376f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27ac7d92ea3a8ac58b1d8d865bd0264b" id="r_ga27ac7d92ea3a8ac58b1d8d865bd0264b"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga27ac7d92ea3a8ac58b1d8d865bd0264b">hid_get_input_report</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, unsigned char *data, size_t length)</td></tr>
<tr class="memdesc:ga27ac7d92ea3a8ac58b1d8d865bd0264b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a input report from a HID device. <br /></td></tr>
<tr class="separator:ga27ac7d92ea3a8ac58b1d8d865bd0264b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d478a5986439ffb838fb1f1ba6ba5ec" id="r_ga8d478a5986439ffb838fb1f1ba6ba5ec"><td class="memItemLeft" align="right" valign="top">void <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec">hid_close</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev)</td></tr>
<tr class="memdesc:ga8d478a5986439ffb838fb1f1ba6ba5ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close a HID device. <br /></td></tr>
<tr class="separator:ga8d478a5986439ffb838fb1f1ba6ba5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga702f45b42d85599eedd602c05661fde5" id="r_ga702f45b42d85599eedd602c05661fde5"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga702f45b42d85599eedd602c05661fde5">hid_get_manufacturer_string</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, wchar_t *string, size_t maxlen)</td></tr>
<tr class="memdesc:ga702f45b42d85599eedd602c05661fde5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get The Manufacturer String from a HID device. <br /></td></tr>
<tr class="separator:ga702f45b42d85599eedd602c05661fde5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga648feb765c5e0da3e821ee84aeab9d99" id="r_ga648feb765c5e0da3e821ee84aeab9d99"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga648feb765c5e0da3e821ee84aeab9d99">hid_get_product_string</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, wchar_t *string, size_t maxlen)</td></tr>
<tr class="memdesc:ga648feb765c5e0da3e821ee84aeab9d99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get The Product String from a HID device. <br /></td></tr>
<tr class="separator:ga648feb765c5e0da3e821ee84aeab9d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3442db3ece59fe248b0625a4c8fca617" id="r_ga3442db3ece59fe248b0625a4c8fca617"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga3442db3ece59fe248b0625a4c8fca617">hid_get_serial_number_string</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, wchar_t *string, size_t maxlen)</td></tr>
<tr class="memdesc:ga3442db3ece59fe248b0625a4c8fca617"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get The Serial Number String from a HID device. <br /></td></tr>
<tr class="separator:ga3442db3ece59fe248b0625a4c8fca617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d8b34ae8cfdd4f4d132814d5b70c128" id="r_ga2d8b34ae8cfdd4f4d132814d5b70c128"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structhid__device__info.html">hid_device_info</a> <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga2d8b34ae8cfdd4f4d132814d5b70c128">hid_get_device_info</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev)</td></tr>
<tr class="memdesc:ga2d8b34ae8cfdd4f4d132814d5b70c128"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get The struct <a class="el" href="structhid__device__info.html">hid_device_info</a> from a HID device. <br /></td></tr>
<tr class="separator:ga2d8b34ae8cfdd4f4d132814d5b70c128"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18546669554746d0f292ca5e23372e06" id="r_ga18546669554746d0f292ca5e23372e06"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#ga18546669554746d0f292ca5e23372e06">hid_get_indexed_string</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, int string_index, wchar_t *string, size_t maxlen)</td></tr>
<tr class="memdesc:ga18546669554746d0f292ca5e23372e06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string from a HID device, based on its string index. <br /></td></tr>
<tr class="separator:ga18546669554746d0f292ca5e23372e06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa8bc561909c1c6b413f1fcdc16333ef" id="r_gaaa8bc561909c1c6b413f1fcdc16333ef"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaaa8bc561909c1c6b413f1fcdc16333ef">hid_get_report_descriptor</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev, unsigned char *buf, size_t buf_size)</td></tr>
<tr class="memdesc:gaaa8bc561909c1c6b413f1fcdc16333ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a report descriptor from a HID device. <br /></td></tr>
<tr class="separator:gaaa8bc561909c1c6b413f1fcdc16333ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabdb1e88a803bab198333a3c5f131b12e" id="r_gabdb1e88a803bab198333a3c5f131b12e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const wchar_t *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gabdb1e88a803bab198333a3c5f131b12e">hid_error</a> (<a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *dev)</td></tr>
<tr class="memdesc:gabdb1e88a803bab198333a3c5f131b12e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string describing the last error which occurred. <br /></td></tr>
<tr class="separator:gabdb1e88a803bab198333a3c5f131b12e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea589e58403a465361a347c0754a3da2" id="r_gaea589e58403a465361a347c0754a3da2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const struct <a class="el" href="structhid__api__version.html">hid_api_version</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gaea589e58403a465361a347c0754a3da2">hid_version</a> (void)</td></tr>
<tr class="memdesc:gaea589e58403a465361a347c0754a3da2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a runtime version of the library. <br /></td></tr>
<tr class="separator:gaea589e58403a465361a347c0754a3da2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacbceccb9fd443fd7cb164dee029fbf64" id="r_gacbceccb9fd443fd7cb164dee029fbf64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const char *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__API.html#gacbceccb9fd443fd7cb164dee029fbf64">hid_version_str</a> (void)</td></tr>
<tr class="memdesc:gacbceccb9fd443fd7cb164dee029fbf64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a runtime version string of the library. <br /></td></tr>
<tr class="separator:gacbceccb9fd443fd7cb164dee029fbf64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaf415391c655f68807580fe3fb8f7ba67" name="gaf415391c655f68807580fe3fb8f7ba67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf415391c655f68807580fe3fb8f7ba67">&#9670;&#160;</a></span>HID_API_MAKE_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_API_MAKE_VERSION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">mj, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">mn, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">p&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;(((mj) &lt;&lt; 24) | ((mn) &lt;&lt; 8) | (p))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;. </p>
<p>This macro was added in version 0.12.0.</p>
<p>Convenient function to be used for compile-time checks, like: </p><div class="fragment"><div class="line"><span class="preprocessor">#if HID_API_VERSION &gt;= HID_API_MAKE_VERSION(0, 12, 0)</span></div>
</div><!-- fragment --> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a28">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga4e861f585ad041d94b142e1c2ee00b3f" name="ga4e861f585ad041d94b142e1c2ee00b3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e861f585ad041d94b142e1c2ee00b3f">&#9670;&#160;</a></span>HID_API_MAX_REPORT_DESCRIPTOR_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_API_MAX_REPORT_DESCRIPTOR_SIZE&#160;&#160;&#160;4096</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum expected HID Report descriptor size in bytes. </p>
<p>Since version 0.13.0, <a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a> &gt;= <a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67" title="Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;.">HID_API_MAKE_VERSION(0, 13, 0)</a> </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a13">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gade33c6fcd36510e02004311124ea2093" name="gade33c6fcd36510e02004311124ea2093"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade33c6fcd36510e02004311124ea2093">&#9670;&#160;</a></span>HID_API_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_API_VERSION&#160;&#160;&#160;<a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67">HID_API_MAKE_VERSION</a>(<a class="el" href="group__API.html#ga18c2d93881cb81d8bbfe6f745853ee35">HID_API_VERSION_MAJOR</a>, <a class="el" href="group__API.html#gadea0ff99909e90630d71c3083ee7e1c5">HID_API_VERSION_MINOR</a>, <a class="el" href="group__API.html#ga1d5251509ebfa4179e477c5cd79a6d23">HID_API_VERSION_PATCH</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Static/compile-time version of the library. </p>
<p>This macro was added in version 0.12.0.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67">HID_API_MAKE_VERSION</a>. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a27">test.c</a>.</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga15cb543842973ca41daa21feaec534ce" name="ga15cb543842973ca41daa21feaec534ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15cb543842973ca41daa21feaec534ce">&#9670;&#160;</a></span>hid_bus_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>HID underlying bus types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e" name="gga15cb543842973ca41daa21feaec534ceacab9ef7570aa48c13a99b28c61ae918e"></a>HID_API_BUS_UNKNOWN&#160;</td><td class="fielddoc"><p>Unknown bus type </p>
</td></tr>
<tr><td class="fieldname"><a id="gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d" name="gga15cb543842973ca41daa21feaec534cea77e86719dfaeabc96759f6cff3a5ca8d"></a>HID_API_BUS_USB&#160;</td><td class="fielddoc"><p>USB bus Specifications: <a href="https://usb.org/hid">https://usb.org/hid</a> </p>
</td></tr>
<tr><td class="fieldname"><a id="gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4" name="gga15cb543842973ca41daa21feaec534cead412c6f0da75b302b713af3a6394a0d4"></a>HID_API_BUS_BLUETOOTH&#160;</td><td class="fielddoc"><p>Bluetooth or Bluetooth LE bus Specifications: <a href="https://www.bluetooth.com/specifications/specs/human-interface-device-profile-1-1-1/">https://www.bluetooth.com/specifications/specs/human-interface-device-profile-1-1-1/</a> <a href="https://www.bluetooth.com/specifications/specs/hid-service-1-0/">https://www.bluetooth.com/specifications/specs/hid-service-1-0/</a> <a href="https://www.bluetooth.com/specifications/specs/hid-over-gatt-profile-1-0/">https://www.bluetooth.com/specifications/specs/hid-over-gatt-profile-1-0/</a> </p>
</td></tr>
<tr><td class="fieldname"><a id="gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0" name="gga15cb543842973ca41daa21feaec534ceafdf48944998bb760c6995402eea306a0"></a>HID_API_BUS_I2C&#160;</td><td class="fielddoc"><p>I2C bus Specifications: <a href="https://docs.microsoft.com/previous-versions/windows/hardware/design/dn642101(v=vs.85)">https://docs.microsoft.com/previous-versions/windows/hardware/design/dn642101(v=vs.85)</a> </p>
</td></tr>
<tr><td class="fieldname"><a id="gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38" name="gga15cb543842973ca41daa21feaec534cea092944e74cc9fe695c08f9e149dcbb38"></a>HID_API_BUS_SPI&#160;</td><td class="fielddoc"><p>SPI bus Specifications: <a href="https://www.microsoft.com/download/details.aspx?id=103325">https://www.microsoft.com/download/details.aspx?id=103325</a> </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8d478a5986439ffb838fb1f1ba6ba5ec" name="ga8d478a5986439ffb838fb1f1ba6ba5ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d478a5986439ffb838fb1f1ba6ba5ec">&#9670;&#160;</a></span>hid_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a HID device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a17">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaae7d1c3e90835556ddc73fabe3a9ca9d" name="gaae7d1c3e90835556ddc73fabe3a9ca9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae7d1c3e90835556ddc73fabe3a9ca9d">&#9670;&#160;</a></span>hid_enumerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structhid__device__info.html">hid_device_info</a> <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_enumerate </td>
<td>(</td>
<td class="paramtype">unsigned short&#160;</td>
<td class="paramname"><em>vendor_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short&#160;</td>
<td class="paramname"><em>product_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumerate the HID Devices. </p>
<p>This function returns a linked list of all the HID devices attached to the system which match vendor_id and product_id. If <code>vendor_id</code> is set to 0 then any vendor matches. If <code>product_id</code> is set to 0 then any product matches. If <code>vendor_id</code> and <code>product_id</code> are both set to 0, then all HID devices will be returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vendor_id</td><td>The Vendor ID (VID) of the types of device to open. </td></tr>
<tr><td class="paramname">product_id</td><td>The Product ID (PID) of the types of device to open.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns a pointer to a linked list of type struct <a class="el" href="structhid__device__info.html">hid_device_info</a>, containing information about the HID devices attached to the system, or NULL in the case of failure or if no HID devices present in the system. Call hid_error(NULL) to get the failure reason.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The returned value by this function must to be freed by calling <a class="el" href="group__API.html#gafc2d2adf71db3784b783b9a554527aa4" title="Free an enumeration Linked List.">hid_free_enumeration()</a>, when not needed anymore. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a31">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gabdb1e88a803bab198333a3c5f131b12e" name="gabdb1e88a803bab198333a3c5f131b12e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabdb1e88a803bab198333a3c5f131b12e">&#9670;&#160;</a></span>hid_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const wchar_t *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a string describing the last error which occurred. </p>
<p>This function is intended for logging/debugging purposes.</p>
<p>This function guarantees to never return NULL. If there was no error in the last function call - the returned string clearly indicates that.</p>
<p>Any HIDAPI function that can explicitly indicate an execution failure (e.g. by an error code, or by returning NULL) - may set the error string, to be returned by this function.</p>
<p>Strings returned from <a class="el" href="group__API.html#gabdb1e88a803bab198333a3c5f131b12e" title="Get a string describing the last error which occurred.">hid_error()</a> must not be freed by the user, i.e. owned by HIDAPI library. Device-specific error string may remain allocated at most until <a class="el" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec" title="Close a HID device.">hid_close()</a> is called. Global error string may remain allocated at most until <a class="el" href="group__API.html#gacf5da9ce37132eba69fc259f17f13023" title="Finalize the HIDAPI library.">hid_exit()</a> is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>, or NULL to get the last non-device-specific error (e.g. for errors in <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a> or <a class="el" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d" title="Enumerate the HID Devices.">hid_enumerate()</a>).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string describing the last error (if any). </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a15">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gacf5da9ce37132eba69fc259f17f13023" name="gacf5da9ce37132eba69fc259f17f13023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacf5da9ce37132eba69fc259f17f13023">&#9670;&#160;</a></span>hid_exit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_exit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalize the HIDAPI library. </p>
<p>This function frees all of the static data associated with HIDAPI. It should be called at the end of execution to avoid memory leaks.</p>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a33">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gafc2d2adf71db3784b783b9a554527aa4" name="gafc2d2adf71db3784b783b9a554527aa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc2d2adf71db3784b783b9a554527aa4">&#9670;&#160;</a></span>hid_free_enumeration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_free_enumeration </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structhid__device__info.html">hid_device_info</a> *&#160;</td>
<td class="paramname"><em>devs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an enumeration Linked List. </p>
<p>This function frees a linked list created by <a class="el" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d" title="Enumerate the HID Devices.">hid_enumerate()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">devs</td><td>Pointer to a list of struct_device returned from <a class="el" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d" title="Enumerate the HID Devices.">hid_enumerate()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a32">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga2d8b34ae8cfdd4f4d132814d5b70c128" name="ga2d8b34ae8cfdd4f4d132814d5b70c128"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d8b34ae8cfdd4f4d132814d5b70c128">&#9670;&#160;</a></span>hid_get_device_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structhid__device__info.html">hid_device_info</a> <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_get_device_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get The struct <a class="el" href="structhid__device__info.html">hid_device_info</a> from a HID device. </p>
<p>Since version 0.13.0, <a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a> &gt;= <a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67" title="Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;.">HID_API_MAKE_VERSION(0, 13, 0)</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns a pointer to the struct <a class="el" href="structhid__device__info.html">hid_device_info</a> for this hid_device, or NULL in the case of failure. Call hid_error(dev) to get the failure reason. This struct is valid until the device is closed with <a class="el" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec" title="Close a HID device.">hid_close()</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The returned object is owned by the <code>dev</code>, and SHOULD NOT be freed by the user. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a37">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaa537a4b3c49d638c6ec9dedc08c44601" name="gaa537a4b3c49d638c6ec9dedc08c44601"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa537a4b3c49d638c6ec9dedc08c44601">&#9670;&#160;</a></span>hid_get_feature_report()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_get_feature_report </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a feature report from a HID device. </p>
<p>Set the first byte of <code>data</code>[] to the Report ID of the report to be read. Make sure to allow space for this extra byte in <code>data</code>[]. Upon return, the first byte will still contain the Report ID, and the report data will start in data[1].</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>A buffer to put the read data into, including the Report ID. Set the first byte of <code>data</code>[] to the Report ID of the report to be read, or set it to zero if your device does not use numbered reports. </td></tr>
<tr><td class="paramname">length</td><td>The number of bytes to read, including an extra byte for the report ID. The buffer can be longer than the actual report.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the number of bytes read plus one for the report ID (which is still in the first byte), or -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a23">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga18546669554746d0f292ca5e23372e06" name="ga18546669554746d0f292ca5e23372e06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18546669554746d0f292ca5e23372e06">&#9670;&#160;</a></span>hid_get_indexed_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> hid_get_indexed_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>string_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t *&#160;</td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>maxlen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a string from a HID device, based on its string index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">string_index</td><td>The index of the string to get. </td></tr>
<tr><td class="paramname">string</td><td>A wide string buffer to put the data into. </td></tr>
<tr><td class="paramname">maxlen</td><td>The length of the buffer in multiples of wchar_t.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a38">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga27ac7d92ea3a8ac58b1d8d865bd0264b" name="ga27ac7d92ea3a8ac58b1d8d865bd0264b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga27ac7d92ea3a8ac58b1d8d865bd0264b">&#9670;&#160;</a></span>hid_get_input_report()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_get_input_report </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a input report from a HID device. </p>
<p>Since version 0.10.0, <a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a> &gt;= <a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67" title="Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;.">HID_API_MAKE_VERSION(0, 10, 0)</a></p>
<p>Set the first byte of <code>data</code>[] to the Report ID of the report to be read. Make sure to allow space for this extra byte in <code>data</code>[]. Upon return, the first byte will still contain the Report ID, and the report data will start in data[1].</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>A buffer to put the read data into, including the Report ID. Set the first byte of <code>data</code>[] to the Report ID of the report to be read, or set it to zero if your device does not use numbered reports. </td></tr>
<tr><td class="paramname">length</td><td>The number of bytes to read, including an extra byte for the report ID. The buffer can be longer than the actual report.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the number of bytes read plus one for the report ID (which is still in the first byte), or -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a21">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga702f45b42d85599eedd602c05661fde5" name="ga702f45b42d85599eedd602c05661fde5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga702f45b42d85599eedd602c05661fde5">&#9670;&#160;</a></span>hid_get_manufacturer_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> hid_get_manufacturer_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t *&#160;</td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>maxlen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get The Manufacturer String from a HID device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">string</td><td>A wide string buffer to put the data into. </td></tr>
<tr><td class="paramname">maxlen</td><td>The length of the buffer in multiples of wchar_t.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a34">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga648feb765c5e0da3e821ee84aeab9d99" name="ga648feb765c5e0da3e821ee84aeab9d99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga648feb765c5e0da3e821ee84aeab9d99">&#9670;&#160;</a></span>hid_get_product_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> hid_get_product_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t *&#160;</td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>maxlen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get The Product String from a HID device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">string</td><td>A wide string buffer to put the data into. </td></tr>
<tr><td class="paramname">maxlen</td><td>The length of the buffer in multiples of wchar_t.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a35">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaaa8bc561909c1c6b413f1fcdc16333ef" name="gaaa8bc561909c1c6b413f1fcdc16333ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa8bc561909c1c6b413f1fcdc16333ef">&#9670;&#160;</a></span>hid_get_report_descriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> hid_get_report_descriptor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>buf_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a report descriptor from a HID device. </p>
<p>Since version 0.14.0, <a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a> &gt;= <a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67" title="Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;.">HID_API_MAKE_VERSION(0, 14, 0)</a></p>
<p>User has to provide a preallocated buffer where descriptor will be copied to. The recommended size for preallocated buffer is <a class="el" href="group__API.html#ga4e861f585ad041d94b142e1c2ee00b3f">HID_API_MAX_REPORT_DESCRIPTOR_SIZE</a> bytes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">buf</td><td>The buffer to copy descriptor into. </td></tr>
<tr><td class="paramname">buf_size</td><td>The size of the buffer in bytes.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns non-negative number of bytes actually copied, or -1 on error. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a14">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga3442db3ece59fe248b0625a4c8fca617" name="ga3442db3ece59fe248b0625a4c8fca617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3442db3ece59fe248b0625a4c8fca617">&#9670;&#160;</a></span>hid_get_serial_number_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a> hid_get_serial_number_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t *&#160;</td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>maxlen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get The Serial Number String from a HID device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">string</td><td>A wide string buffer to put the data into. </td></tr>
<tr><td class="paramname">maxlen</td><td>The length of the buffer in multiples of wchar_t.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a36">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga142ffc1b0b7a7fa412d3862b2a17164b" name="ga142ffc1b0b7a7fa412d3862b2a17164b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga142ffc1b0b7a7fa412d3862b2a17164b">&#9670;&#160;</a></span>hid_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the HIDAPI library. </p>
<p>This function initializes the HIDAPI library. Calling it is not strictly necessary, as it will be called automatically by <a class="el" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d" title="Enumerate the HID Devices.">hid_enumerate()</a> and any of the hid_open_*() functions if it is needed. This function should be called at the beginning of execution however, if there is a chance of HIDAPI handles being opened by different threads simultaneously.</p>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. Call hid_error(NULL) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a30">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga6946f7e2f5d225d69308611db1e31ede" name="ga6946f7e2f5d225d69308611db1e31ede"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6946f7e2f5d225d69308611db1e31ede">&#9670;&#160;</a></span>hid_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_open </td>
<td>(</td>
<td class="paramtype">unsigned short&#160;</td>
<td class="paramname"><em>vendor_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short&#160;</td>
<td class="paramname"><em>product_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>serial_number</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number. </p>
<p>If <code>serial_number</code> is NULL, the first device with the specified VID and PID is opened.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vendor_id</td><td>The Vendor ID (VID) of the device to open. </td></tr>
<tr><td class="paramname">product_id</td><td>The Product ID (PID) of the device to open. </td></tr>
<tr><td class="paramname">serial_number</td><td>The Serial Number of the device to open (Optionally NULL).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns a pointer to a <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> object on success or NULL on failure. Call hid_error(NULL) to get the failure reason.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The returned object must be freed by calling <a class="el" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec" title="Close a HID device.">hid_close()</a>, when not needed anymore. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a19">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga954ecb58b5dfb4a6ef6be3dcd520e42f" name="ga954ecb58b5dfb4a6ef6be3dcd520e42f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga954ecb58b5dfb4a6ef6be3dcd520e42f">&#9670;&#160;</a></span>hid_open_path()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_open_path </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a HID device by its path name. </p>
<p>The path name be determined by calling <a class="el" href="group__API.html#gaae7d1c3e90835556ddc73fabe3a9ca9d" title="Enumerate the HID Devices.">hid_enumerate()</a>, or a platform-specific path name can be used (eg: /dev/hidraw0 on Linux).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path name of the device to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns a pointer to a <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> object on success or NULL on failure. Call hid_error(NULL) to get the failure reason.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The returned object must be freed by calling <a class="el" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec" title="Close a HID device.">hid_close()</a>, when not needed anymore. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a16">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga2224269e8cd7c789f9fd4864a73f8c95" name="ga2224269e8cd7c789f9fd4864a73f8c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2224269e8cd7c789f9fd4864a73f8c95">&#9670;&#160;</a></span>hid_read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read an Input report from a HID device. </p>
<p>Input reports are returned to the host through the INTERRUPT IN endpoint. The first byte will contain the Report number if the device uses numbered reports.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>A buffer to put the read data into. </td></tr>
<tr><td class="paramname">length</td><td>The number of bytes to read. For devices with multiple reports, make sure to read an extra byte for the report number.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the actual number of bytes read and -1 on error. Call hid_read_error(dev) to get the failure reason. If no packet was available to be read and the handle is in non-blocking mode, this function returns 0.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function doesn't change the buffer returned by the hid_error(dev). </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a40">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga5d7137c63986df36560e39289e4928e1" name="ga5d7137c63986df36560e39289e4928e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d7137c63986df36560e39289e4928e1">&#9670;&#160;</a></span>hid_read_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const wchar_t *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_read_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a string describing the last error which occurred during hid_read/hid_read_timeout. </p>
<p>Since version 0.15.0, <a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a> &gt;= <a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67" title="Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;.">HID_API_MAKE_VERSION(0, 15, 0)</a></p>
<p>This function is intended for logging/debugging purposes.</p>
<p>This function guarantees to never return NULL for a valid dev. If there was no error in the last call to hid_read/hid_read_error - the returned string clearly indicates that.</p>
<p>Strings returned from <a class="el" href="group__API.html#ga5d7137c63986df36560e39289e4928e1" title="Get a string describing the last error which occurred during hid_read/hid_read_timeout.">hid_read_error()</a> must not be freed by the user, i.e. owned by HIDAPI library. Device-specific error string may remain allocated at most until <a class="el" href="group__API.html#ga8d478a5986439ffb838fb1f1ba6ba5ec" title="Close a HID device.">hid_close()</a> is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle. Shall never be NULL.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string describing the hid_read/hid_read_timeout error (if any). </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a41">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaa5c9ed5aa290688ffac03343989ad75a" name="gaa5c9ed5aa290688ffac03343989ad75a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5c9ed5aa290688ffac03343989ad75a">&#9670;&#160;</a></span>hid_read_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_read_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>milliseconds</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read an Input report from a HID device with timeout. </p>
<p>Input reports are returned to the host through the INTERRUPT IN endpoint. The first byte will contain the Report number if the device uses numbered reports.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>A buffer to put the read data into. </td></tr>
<tr><td class="paramname">length</td><td>The number of bytes to read. For devices with multiple reports, make sure to read an extra byte for the report number. </td></tr>
<tr><td class="paramname">milliseconds</td><td>timeout in milliseconds or -1 for blocking wait.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the actual number of bytes read and -1 on error. Call hid_read_error(dev) to get the failure reason. If no packet was available to be read within the timeout period, this function returns 0.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function doesn't change the buffer returned by the hid_error(dev). </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a20">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gae99a9ddbb5d9b03fddf40fb4a492cbec" name="gae99a9ddbb5d9b03fddf40fb4a492cbec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae99a9ddbb5d9b03fddf40fb4a492cbec">&#9670;&#160;</a></span>hid_send_feature_report()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_send_feature_report </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a Feature report to the device. </p>
<p>Feature reports are sent over the Control endpoint as a Set_Report transfer. The first byte of <code>data</code>[] must contain the Report ID. For devices which only support a single report, this must be set to 0x0. The remaining bytes contain the report data. Since the Report ID is mandatory, calls to <a class="el" href="group__API.html#gae99a9ddbb5d9b03fddf40fb4a492cbec" title="Send a Feature report to the device.">hid_send_feature_report()</a> will always contain one more byte than the report contains. For example, if a hid report is 16 bytes long, 17 bytes must be passed to <a class="el" href="group__API.html#gae99a9ddbb5d9b03fddf40fb4a492cbec" title="Send a Feature report to the device.">hid_send_feature_report()</a>: the Report ID (or 0x0, for devices which do not use numbered reports), followed by the report data (16 bytes). In this example, the length passed in would be 17.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>The data to send, including the report number as the first byte. </td></tr>
<tr><td class="paramname">length</td><td>The length in bytes of the data to send, including the report number.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the actual number of bytes written and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a24">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga6f18ce9abffb0a9e7b1b5bac0e39376f" name="ga6f18ce9abffb0a9e7b1b5bac0e39376f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f18ce9abffb0a9e7b1b5bac0e39376f">&#9670;&#160;</a></span>hid_send_output_report()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_send_output_report </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a Output report to the device. </p>
<p>Since version 0.15.0, <a class="el" href="group__API.html#gade33c6fcd36510e02004311124ea2093">HID_API_VERSION</a> &gt;= <a class="el" href="group__API.html#gaf415391c655f68807580fe3fb8f7ba67" title="Coverts a version as Major/Minor/Patch into a number: &lt;8 bit major&gt;&lt;16 bit minor&gt;&lt;8 bit patch&gt;.">HID_API_MAKE_VERSION(0, 15, 0)</a></p>
<p>Output reports are sent over the Control endpoint as a Set_Report transfer. The first byte of <code>data</code>[] must contain the Report ID. For devices which only support a single report, this must be set to 0x0. The remaining bytes contain the report data. Since the Report ID is mandatory, calls to <a class="el" href="group__API.html#ga6f18ce9abffb0a9e7b1b5bac0e39376f" title="Send a Output report to the device.">hid_send_output_report()</a> will always contain one more byte than the report contains. For example, if a hid report is 16 bytes long, 17 bytes must be passed to <a class="el" href="group__API.html#ga6f18ce9abffb0a9e7b1b5bac0e39376f" title="Send a Output report to the device.">hid_send_output_report()</a>: the Report ID (or 0x0, for devices which do not use numbered reports), followed by the report data (16 bytes). In this example, the length passed in would be 17.</p>
<p>This function sets the return value of <a class="el" href="group__API.html#gabdb1e88a803bab198333a3c5f131b12e" title="Get a string describing the last error which occurred.">hid_error()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>The data to send, including the report number as the first byte. </td></tr>
<tr><td class="paramname">length</td><td>The length in bytes of the data to send, including the report number.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the actual number of bytes written and -1 on error.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d">hid_write</a> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a22">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga0e9af0d8ed72f5610e9297c90b08e242" name="ga0e9af0d8ed72f5610e9297c90b08e242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0e9af0d8ed72f5610e9297c90b08e242">&#9670;&#160;</a></span>hid_set_nonblocking()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_set_nonblocking </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nonblock</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the device handle to be non-blocking. </p>
<p>In non-blocking mode calls to <a class="el" href="group__API.html#ga2224269e8cd7c789f9fd4864a73f8c95" title="Read an Input report from a HID device.">hid_read()</a> will return immediately with a value of 0 if there is no data to be read. In blocking mode, <a class="el" href="group__API.html#ga2224269e8cd7c789f9fd4864a73f8c95" title="Read an Input report from a HID device.">hid_read()</a> will wait (block) until there is data to read before returning.</p>
<p>Nonblocking can be turned on and off at any time.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">nonblock</td><td>enable or not the nonblocking reads<ul>
<li>1 to enable nonblocking</li>
<li>0 to disable nonblocking.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns 0 on success and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a39">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaea589e58403a465361a347c0754a3da2" name="gaea589e58403a465361a347c0754a3da2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea589e58403a465361a347c0754a3da2">&#9670;&#160;</a></span>hid_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const struct <a class="el" href="structhid__api__version.html">hid_api_version</a> *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_version </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a runtime version of the library. </p>
<p>This function is thread-safe.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to statically allocated struct, that contains version. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a29">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gacbceccb9fd443fd7cb164dee029fbf64" name="gacbceccb9fd443fd7cb164dee029fbf64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacbceccb9fd443fd7cb164dee029fbf64">&#9670;&#160;</a></span>hid_version_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> const char *<a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_version_str </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a runtime version string of the library. </p>
<p>This function is thread-safe.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to statically allocated string, that contains version string. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a26">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaa691d2c469b9654128196bf7ef8edd9d" name="gaa691d2c469b9654128196bf7ef8edd9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa691d2c469b9654128196bf7ef8edd9d">&#9670;&#160;</a></span>hid_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a> hid_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write an Output report to a HID device. </p>
<p>The first byte of <code>data</code>[] must contain the Report ID. For devices which only support a single report, this must be set to 0x0. The remaining bytes contain the report data. Since the Report ID is mandatory, calls to <a class="el" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d" title="Write an Output report to a HID device.">hid_write()</a> will always contain one more byte than the report contains. For example, if a hid report is 16 bytes long, 17 bytes must be passed to <a class="el" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d" title="Write an Output report to a HID device.">hid_write()</a>, the Report ID (or 0x0, for devices with a single report), followed by the report data (16 bytes). In this example, the length passed in would be 17.</p>
<p><a class="el" href="group__API.html#gaa691d2c469b9654128196bf7ef8edd9d" title="Write an Output report to a HID device.">hid_write()</a> will send the data on the first interrupt OUT endpoint, if one exists. If it does not the behaviour is as <a class="el" href="group__API.html#ga6f18ce9abffb0a9e7b1b5bac0e39376f">hid_send_output_report</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>A device handle returned from <a class="el" href="group__API.html#ga6946f7e2f5d225d69308611db1e31ede" title="Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number.">hid_open()</a>. </td></tr>
<tr><td class="paramname">data</td><td>The data to send, including the report number as the first byte. </td></tr>
<tr><td class="paramname">length</td><td>The length in bytes of the data to send.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the actual number of bytes written and -1 on error. Call hid_error(dev) to get the failure reason. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a42">test.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 23 2025 01:21:33 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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink