InitializeFeatureReport Method (ReportID)

Initializes a new Feature report for the specified ReportID. The ReportData will contain the current or default settings as specified in the specified report's descriptor.

Declaration Syntax

Visual Basic

Visual C++

public HIDFeatureReport InitializeFeatureReport(
	byte ReportID
)

Public Function InitializeFeatureReport ( _
	ReportID As Byte _
) As HIDFeatureReport

public:
HIDFeatureReport^ InitializeFeatureReport(
	unsigned char ReportID
)

Parameters

ReportID (Byte): [Missing <param name="ReportID"/> documentation for "M:BlueNinjaSoftware.HIDLib.HIDDevice.InitializeFeatureReport(System.Byte)"]

Return Value

[Missing <returns> documentation for M:BlueNinjaSoftware.HIDLib.HIDDevice.InitializeFeatureReport(System.Byte)]

Remarks

Initializing an HID report sets all control data to zero or a control's null value, as defined by the USB HID standard. (Sending or receiving a null value indicates that the current value of a control should not be modified.)

InitializeFeatureReport does the following:

Sets to zero the bit fields of all buttons and values without null values.
Sets the bit field of all controls with null values to their corresponding null value.

InitializeFeatureReport runs at IRQL <= DISPATCH_LEVEL.

Assembly: HIDLib (Module: HIDLib) Version: 0.2.0.1626