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/hidapi_8h.html
Megamouse bee9f60fb0 deploy: f42423643e
2025-05-23 01:21:43 +00:00

296 lines
36 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/hidapi.h File Reference</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f69d011550147a977d318e3e9dc1c41f.html">hidapi</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">hidapi.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;wchar.h&gt;</code><br />
</div>
<p><a href="hidapi_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__api__version.html">hid_api_version</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html">hid_device_info</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aa60150016800ccb88fdf140e8553ae13" id="r_aa60150016800ccb88fdf140e8553ae13"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a></td></tr>
<tr class="separator:aa60150016800ccb88fdf140e8553ae13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af140a25716604e86096670a505a58ee0" id="r_af140a25716604e86096670a505a58ee0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a></td></tr>
<tr class="separator:af140a25716604e86096670a505a58ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70c49eda5025c1bc455af77da19ca312" id="r_a70c49eda5025c1bc455af77da19ca312"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidapi_8h.html#a70c49eda5025c1bc455af77da19ca312">HID_API_EXPORT_CALL</a>&#160;&#160;&#160;<a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a></td></tr>
<tr class="separator:a70c49eda5025c1bc455af77da19ca312"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18c2d93881cb81d8bbfe6f745853ee35" id="r_ga18c2d93881cb81d8bbfe6f745853ee35"><td class="memItemLeft" align="right" valign="top">
#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">
#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">
#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">
#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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa6da74d5686d198dd3e5440e60088fcc" id="r_aa6da74d5686d198dd3e5440e60088fcc"><td class="memItemLeft" align="right" valign="top">typedef struct hid_device_&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a></td></tr>
<tr class="separator:aa6da74d5686d198dd3e5440e60088fcc"><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>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="af140a25716604e86096670a505a58ee0" name="af140a25716604e86096670a505a58ee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af140a25716604e86096670a505a58ee0">&#9670;&#160;</a></span>HID_API_CALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_API_CALL</td>
</tr>
</table>
</div><div class="memdoc">
<p>API call macro </p>
</div>
</div>
<a id="aa60150016800ccb88fdf140e8553ae13" name="aa60150016800ccb88fdf140e8553ae13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa60150016800ccb88fdf140e8553ae13">&#9670;&#160;</a></span>HID_API_EXPORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_API_EXPORT</td>
</tr>
</table>
</div><div class="memdoc">
<p>API export macro </p>
</div>
</div>
<a id="a70c49eda5025c1bc455af77da19ca312" name="a70c49eda5025c1bc455af77da19ca312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70c49eda5025c1bc455af77da19ca312">&#9670;&#160;</a></span>HID_API_EXPORT_CALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_API_EXPORT_CALL&#160;&#160;&#160;<a class="el" href="hidapi_8h.html#aa60150016800ccb88fdf140e8553ae13">HID_API_EXPORT</a> <a class="el" href="hidapi_8h.html#af140a25716604e86096670a505a58ee0">HID_API_CALL</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>API export and call macro </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aa6da74d5686d198dd3e5440e60088fcc" name="aa6da74d5686d198dd3e5440e60088fcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6da74d5686d198dd3e5440e60088fcc">&#9670;&#160;</a></span>hid_device</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct hid_device_ <a class="el" href="hidapi_8h.html#aa6da74d5686d198dd3e5440e60088fcc">hid_device</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>opaque hidapi structure </p>
</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