RPCS3/hidapi
1
0
Fork 0
mirror of https://github.com/RPCS3/hidapi.git synced 2026-07-19 13:34:37 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
hidapi/structhid__device__info.html
T
Megamouse bee9f60fb0 deploy: f42423643e
2025-05-23 01:21:43 +00:00

327 lines
17 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: hid_device_info Struct 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">hid_device_info Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="hidapi_8h_source.html">hidapi.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a6384b5bf4d9583598e5f5a889f240921" id="r_a6384b5bf4d9583598e5f5a889f240921"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a6384b5bf4d9583598e5f5a889f240921">path</a></td></tr>
<tr class="separator:a6384b5bf4d9583598e5f5a889f240921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5037a3914e0bd8a3f821d1be9376c709" id="r_a5037a3914e0bd8a3f821d1be9376c709"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a5037a3914e0bd8a3f821d1be9376c709">vendor_id</a></td></tr>
<tr class="separator:a5037a3914e0bd8a3f821d1be9376c709"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04595915457b4374492edb1fdb62d65d" id="r_a04595915457b4374492edb1fdb62d65d"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a04595915457b4374492edb1fdb62d65d">product_id</a></td></tr>
<tr class="separator:a04595915457b4374492edb1fdb62d65d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80756cea367e1566f966438984b75faf" id="r_a80756cea367e1566f966438984b75faf"><td class="memItemLeft" align="right" valign="top">wchar_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a80756cea367e1566f966438984b75faf">serial_number</a></td></tr>
<tr class="separator:a80756cea367e1566f966438984b75faf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a832d25260f7ec17ef008e53e50e1d0" id="r_a6a832d25260f7ec17ef008e53e50e1d0"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a6a832d25260f7ec17ef008e53e50e1d0">release_number</a></td></tr>
<tr class="separator:a6a832d25260f7ec17ef008e53e50e1d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a484eebf746220cd2910954cc861759b7" id="r_a484eebf746220cd2910954cc861759b7"><td class="memItemLeft" align="right" valign="top">wchar_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a484eebf746220cd2910954cc861759b7">manufacturer_string</a></td></tr>
<tr class="separator:a484eebf746220cd2910954cc861759b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aceee256b4f7cd7fdd9fa5d556f49d221" id="r_aceee256b4f7cd7fdd9fa5d556f49d221"><td class="memItemLeft" align="right" valign="top">wchar_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#aceee256b4f7cd7fdd9fa5d556f49d221">product_string</a></td></tr>
<tr class="separator:aceee256b4f7cd7fdd9fa5d556f49d221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab811117f8084ce2036815bdd33b16b3b" id="r_ab811117f8084ce2036815bdd33b16b3b"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#ab811117f8084ce2036815bdd33b16b3b">usage_page</a></td></tr>
<tr class="separator:ab811117f8084ce2036815bdd33b16b3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47f8011d58bcddd67f1403d6d3b4cab6" id="r_a47f8011d58bcddd67f1403d6d3b4cab6"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a47f8011d58bcddd67f1403d6d3b4cab6">usage</a></td></tr>
<tr class="separator:a47f8011d58bcddd67f1403d6d3b4cab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9163d8d5d7db8dc47bddfaf876e17547" id="r_a9163d8d5d7db8dc47bddfaf876e17547"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a9163d8d5d7db8dc47bddfaf876e17547">interface_number</a></td></tr>
<tr class="separator:a9163d8d5d7db8dc47bddfaf876e17547"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bfebc240baf3bdaf03965816e11f149" id="r_a2bfebc240baf3bdaf03965816e11f149"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structhid__device__info.html">hid_device_info</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#a2bfebc240baf3bdaf03965816e11f149">next</a></td></tr>
<tr class="separator:a2bfebc240baf3bdaf03965816e11f149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa3c7d42a0892d9f1f25976709cf5aa2" id="r_afa3c7d42a0892d9f1f25976709cf5aa2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhid__device__info.html#afa3c7d42a0892d9f1f25976709cf5aa2">bus_type</a></td></tr>
<tr class="separator:afa3c7d42a0892d9f1f25976709cf5aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>hidapi info structure </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#_a1">test.c</a>.</dd>
</dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="afa3c7d42a0892d9f1f25976709cf5aa2" name="afa3c7d42a0892d9f1f25976709cf5aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa3c7d42a0892d9f1f25976709cf5aa2">&#9670;&#160;</a></span>bus_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__API.html#ga15cb543842973ca41daa21feaec534ce">hid_bus_type</a> hid_device_info::bus_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying bus type 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#a12">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a9163d8d5d7db8dc47bddfaf876e17547" name="a9163d8d5d7db8dc47bddfaf876e17547"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9163d8d5d7db8dc47bddfaf876e17547">&#9670;&#160;</a></span>interface_number</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hid_device_info::interface_number</td>
</tr>
</table>
</div><div class="memdoc">
<p>The USB interface which this logical device represents.</p>
<p>Valid only if the device is a USB HID device. Set to -1 in all other cases. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a9">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a484eebf746220cd2910954cc861759b7" name="a484eebf746220cd2910954cc861759b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a484eebf746220cd2910954cc861759b7">&#9670;&#160;</a></span>manufacturer_string</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wchar_t* hid_device_info::manufacturer_string</td>
</tr>
</table>
</div><div class="memdoc">
<p>Manufacturer String </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a6">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a2bfebc240baf3bdaf03965816e11f149" name="a2bfebc240baf3bdaf03965816e11f149"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bfebc240baf3bdaf03965816e11f149">&#9670;&#160;</a></span>next</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>* hid_device_info::next</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the next device </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a18">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a6384b5bf4d9583598e5f5a889f240921" name="a6384b5bf4d9583598e5f5a889f240921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6384b5bf4d9583598e5f5a889f240921">&#9670;&#160;</a></span>path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* hid_device_info::path</td>
</tr>
</table>
</div><div class="memdoc">
<p>Platform-specific device path </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a4">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a04595915457b4374492edb1fdb62d65d" name="a04595915457b4374492edb1fdb62d65d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04595915457b4374492edb1fdb62d65d">&#9670;&#160;</a></span>product_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short hid_device_info::product_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Device Product ID </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a3">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="aceee256b4f7cd7fdd9fa5d556f49d221" name="aceee256b4f7cd7fdd9fa5d556f49d221"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aceee256b4f7cd7fdd9fa5d556f49d221">&#9670;&#160;</a></span>product_string</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wchar_t* hid_device_info::product_string</td>
</tr>
</table>
</div><div class="memdoc">
<p>Product string </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a7">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a6a832d25260f7ec17ef008e53e50e1d0" name="a6a832d25260f7ec17ef008e53e50e1d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a832d25260f7ec17ef008e53e50e1d0">&#9670;&#160;</a></span>release_number</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short hid_device_info::release_number</td>
</tr>
</table>
</div><div class="memdoc">
<p>Device Release Number in binary-coded decimal, also known as Device Version Number </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a8">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a80756cea367e1566f966438984b75faf" name="a80756cea367e1566f966438984b75faf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80756cea367e1566f966438984b75faf">&#9670;&#160;</a></span>serial_number</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wchar_t* hid_device_info::serial_number</td>
</tr>
</table>
</div><div class="memdoc">
<p>Serial Number </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a5">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a47f8011d58bcddd67f1403d6d3b4cab6" name="a47f8011d58bcddd67f1403d6d3b4cab6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47f8011d58bcddd67f1403d6d3b4cab6">&#9670;&#160;</a></span>usage</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short hid_device_info::usage</td>
</tr>
</table>
</div><div class="memdoc">
<p>Usage for this Device/Interface (Windows/Mac/hidraw only) </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a10">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="ab811117f8084ce2036815bdd33b16b3b" name="ab811117f8084ce2036815bdd33b16b3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab811117f8084ce2036815bdd33b16b3b">&#9670;&#160;</a></span>usage_page</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short hid_device_info::usage_page</td>
</tr>
</table>
</div><div class="memdoc">
<p>Usage Page for this Device/Interface (Windows/Mac/hidraw only) </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a11">test.c</a>.</dd>
</dl>
</div>
</div>
<a id="a5037a3914e0bd8a3f821d1be9376c709" name="a5037a3914e0bd8a3f821d1be9376c709"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5037a3914e0bd8a3f821d1be9376c709">&#9670;&#160;</a></span>vendor_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short hid_device_info::vendor_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Device Vendor ID </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="test_8c-example.html#a2">test.c</a>.</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>hidapi/<a class="el" href="hidapi_8h_source.html">hidapi.h</a></li>
</ul>
</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