HidFeatureReport HidFeatureReport HidFeatureReport HidFeatureReport Class

Definition

Namespace:
Windows.Devices.HumanInterfaceDevice Windows.Devices.HumanInterfaceDevice Windows.Devices.HumanInterfaceDevice Windows.Devices.HumanInterfaceDevice
Edit

Represents a feature report.

Feature reports are issued by both the device and the host. Devices issue feature reports to describe their capabilities and default settings to a host. Hosts issue feature reports to make requests of the device.

public : sealed class HidFeatureReport : IHidFeatureReportpublic sealed class HidFeatureReport : IHidFeatureReportPublic NotInheritable Class HidFeatureReport Implements IHidFeatureReport// You can use this class in JavaScript.
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Data Data Data Data

Edit

Retrieves, or sets, the data associated with a given feature report.

public : IBuffer Data { get; set; }public IBuffer Data { get; set; }Public ReadWrite Property Data As IBuffer// You can use this property in JavaScript.
Value
IBuffer IBuffer IBuffer IBuffer

The feature-report data.

Id Id Id Id

Edit

Retrieves the identifier associated with a given feature report.

public : ushort Id { get; }public ushort Id { get; }Public ReadOnly Property Id As ushort// You can use this property in JavaScript.
Value
ushort ushort ushort ushort

The feature report identifier.

Methods

GetBooleanControl(UInt16, UInt16) GetBooleanControl(UInt16, UInt16) GetBooleanControl(UInt16, UInt16) GetBooleanControl(UInt16, UInt16)

Edit

Retrieves the Boolean control associated with the usagePage and usageId parameter and found in the given feature report.

public : HidBooleanControl GetBooleanControl(unsigned short usagePage, unsigned short usageId)public HidBooleanControl GetBooleanControl(UInt16 usagePage, UInt16 usageId)Public Function GetBooleanControl(usagePage As UInt16, usageId As UInt16) As HidBooleanControl// You can use this method in JavaScript.
Parameters
usagePage
unsigned short UInt16 UInt16 UInt16

The usage page of the top-level collection for the given HID device.

usageId
unsigned short UInt16 UInt16 UInt16

The usage identifier of the top-level collection for the given HID device.

Returns
HidBooleanControl HidBooleanControl HidBooleanControl HidBooleanControl

A HidBooleanControl object.

GetBooleanControlByDescription(HidBooleanControlDescription) GetBooleanControlByDescription(HidBooleanControlDescription) GetBooleanControlByDescription(HidBooleanControlDescription) GetBooleanControlByDescription(HidBooleanControlDescription)

Edit

Retrieves the Boolean control described by the controlDescription parameter and found in the given feature report.

public : HidBooleanControl GetBooleanControlByDescription(HidBooleanControlDescription controlDescription)public HidBooleanControl GetBooleanControlByDescription(HidBooleanControlDescription controlDescription)Public Function GetBooleanControlByDescription(controlDescription As HidBooleanControlDescription) As HidBooleanControl// You can use this method in JavaScript.
Parameters
controlDescription
HidBooleanControlDescription HidBooleanControlDescription HidBooleanControlDescription HidBooleanControlDescription

A HidBooleanControlDescription object.

Returns
HidBooleanControl HidBooleanControl HidBooleanControl HidBooleanControl

A HidBooleanControl object.

GetNumericControl(UInt16, UInt16) GetNumericControl(UInt16, UInt16) GetNumericControl(UInt16, UInt16) GetNumericControl(UInt16, UInt16)

Edit

Retrieves the numeric control associated with the usagePage and usageId parameters and found in the given feature report.

public : HidNumericControl GetNumericControl(unsigned short usagePage, unsigned short usageId)public HidNumericControl GetNumericControl(UInt16 usagePage, UInt16 usageId)Public Function GetNumericControl(usagePage As UInt16, usageId As UInt16) As HidNumericControl// You can use this method in JavaScript.
Parameters
usagePage
unsigned short UInt16 UInt16 UInt16

The usage page of the top-level collection for the given HID device.

usageId
unsigned short UInt16 UInt16 UInt16

The usage identifier of the top-level collection for the given HID device.

Returns
HidNumericControl HidNumericControl HidNumericControl HidNumericControl

A HidNumericControl object.

GetNumericControlByDescription(HidNumericControlDescription) GetNumericControlByDescription(HidNumericControlDescription) GetNumericControlByDescription(HidNumericControlDescription) GetNumericControlByDescription(HidNumericControlDescription)

Edit

Retrieves the numeric control described by the controlDescription parameter and found in the given feature report.

public : HidNumericControl GetNumericControlByDescription(HidNumericControlDescription controlDescription)public HidNumericControl GetNumericControlByDescription(HidNumericControlDescription controlDescription)Public Function GetNumericControlByDescription(controlDescription As HidNumericControlDescription) As HidNumericControl// You can use this method in JavaScript.
Parameters
controlDescription
HidNumericControlDescription HidNumericControlDescription HidNumericControlDescription HidNumericControlDescription

A HidNumericControlDescription object.

Returns
HidNumericControl HidNumericControl HidNumericControl HidNumericControl

A HidNumericControl object.