HidFeatureReport HidFeatureReport HidFeatureReport HidFeatureReport Class

Definition

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 : IHidFeatureReport
public sealed class HidFeatureReport : IHidFeatureReport
Public NotInheritable Class HidFeatureReport Implements IHidFeatureReport
// This class does not provide a public constructor.
Attributes
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

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
var iBuffer = hidFeatureReport.data;
hidFeatureReport.data = iBuffer;
Value
IBuffer IBuffer IBuffer IBuffer

The feature-report data.

Id Id Id Id

Retrieves the identifier associated with a given feature report.

public : ushort Id { get; }
public ushort Id { get; }
Public ReadOnly Property Id As ushort
var ushort = hidFeatureReport.id;
Value
ushort ushort ushort ushort

The feature report identifier.

Methods

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

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
var hidBooleanControl = hidFeatureReport.getBooleanControl(usagePage, usageId);
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

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

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
var hidBooleanControl = hidFeatureReport.getBooleanControlByDescription(controlDescription);
Parameters
Returns

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

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
var hidNumericControl = hidFeatureReport.getNumericControl(usagePage, usageId);
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

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

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
var hidNumericControl = hidFeatureReport.getNumericControlByDescription(controlDescription);
Parameters
Returns