HidDevice.GetBooleanControlDescriptions | getBooleanControlDescriptions method

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

Syntax


var iVectorView = hidDevice.getBooleanControlDescriptions(reportType, usagePage, usageId);

Parameters

reportType

Type: HidReportType

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

usagePage

Type: Number [JavaScript] | System.UInt16 [.NET] | uint16 [C++]

Identifies the usage page associated with the controls.

usageId

Type: Number [JavaScript] | System.UInt16 [.NET] | uint16 [C++]

Identifies the usage associated with the controls.

Return value

Type: IVectorView<HidBooleanControlDescription> [JavaScript/C++] | System.Collections.Generic.IReadOnlyList<HidBooleanControlDescription> [.NET]

A vector of HidBooleanControlDescription objects.

Remarks

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

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Namespace

Windows.Devices.HumanInterfaceDevice
Windows::Devices::HumanInterfaceDevice [C++]

Metadata

Windows.winmd

See also

HidDevice

 

 

Build date: 11/16/2013

Show:
© 2014 Microsoft