HidDevice.GetBooleanControlDescriptions(HidReportType, UInt16, UInt16) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the descriptions of the boolean controls for the given HID device.
public:
virtual IVectorView<HidBooleanControlDescription ^> ^ GetBooleanControlDescriptions(HidReportType reportType, unsigned short usagePage, unsigned short usageId) = GetBooleanControlDescriptions;IVectorView<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType const& reportType, uint16_t const& usagePage, uint16_t const& usageId);public IReadOnlyList<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType reportType, ushort usagePage, ushort usageId);function getBooleanControlDescriptions(reportType, usagePage, usageId)Public Function GetBooleanControlDescriptions (reportType As HidReportType, usagePage As UShort, usageId As UShort) As IReadOnlyList(Of HidBooleanControlDescription)Parameters
- reportType
- HidReportType
Specifies the type of report for which the control descriptions are requested.
- usagePage
-
UInt16
unsigned short
uint16_t
Identifies the usage page associated with the controls.
A value of 0 is treated as a wild card for all usage pages.
- usageId
-
UInt16
unsigned short
uint16_t
Identifies the usage associated with the controls.
A value of 0 is treated as a wild card for all usage IDs.
Returns
A vector of HidBooleanControlDescription objects.
Remarks
Boolean controls are simple controls that return On/Off values. (They are sometimes referred to as button controls.)