HidDevice.GetBooleanControlDescriptions(HidReportType, UInt16, UInt16) HidDevice.GetBooleanControlDescriptions(HidReportType, UInt16, UInt16) HidDevice.GetBooleanControlDescriptions(HidReportType, UInt16, UInt16) HidDevice.GetBooleanControlDescriptions(HidReportType, UInt16, UInt16) HidDevice.GetBooleanControlDescriptions(HidReportType, UInt16, UInt16) Method

Definition

Retrieves the descriptions of the boolean controls for the given HID device.

public : IVectorView<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType reportType, unsigned short usagePage, unsigned short usageId)
IVectorView<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType reportType, UInt16 usagePage, UInt16 usageId) const;
public IReadOnlyList<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType reportType, UInt16 usagePage, UInt16 usageId)
Public Function GetBooleanControlDescriptions(reportType As HidReportType, usagePage As UInt16, usageId As UInt16) As IReadOnlyList<HidBooleanControlDescription>(Of HidBooleanControlDescription)
var iVectorView = hidDevice.getBooleanControlDescriptions(reportType, usagePage, usageId);

Parameters

reportType
HidReportType HidReportType HidReportType

Specifies the type of report for which the control descriptions are requested.

usagePage
UInt16 UInt16 UInt16

Identifies the usage page associated with the controls.

A value of 0 is treated as a wild card for all usage pages.

usageId
UInt16 UInt16 UInt16

Identifies the usage associated with the controls.

A value of 0 is treated as a wild card for all usage IDs.

Returns

IReadOnlyList<HidBooleanControlDescription> IReadOnlyList<HidBooleanControlDescription> IReadOnlyList<HidBooleanControlDescription>

A vector of HidBooleanControlDescription objects.

Remarks

Boolean controls are simple controls that return On/Off values. (They are sometimes referred to as button controls.)

See also