The IOCTL_HID_READ_REPORT request transfers an input report from a HIDClass device into the HID class driver's buffer.
For general information about HIDClass devices, see HID Collections.
Parameters.DeviceIoControl.OutputBufferLength contains the size of the buffer provided at Irp->UserBuffer.
Input Buffer Length
The size of OutputBufferLength
HID minidriver fills the system-resident buffer pointed to by Irp->UserBuffer with the report data retrieved from the device.
Output Buffer Length
The size of the UserBuffer.
HID minidrivers that carry out the I/O to the device set the following fields of Irp->IoStatus:
- Information is set to the number of bytes transferred from the device.
- Status is set to STATUS_SUCCESS if the transfer completed without error. Otherwise, it is set to an appropriate NTSTATUS error code.
IOCTL_HID_READ_REPORT is typically used for continuously completing input reports that are sent by the device. This IOCTL is sent down by the HID class driver (HIDCLASS) in ping-pong fashion. In other words, as soon as a request is fulfilled (completed), another one can be sent down to the device, allowing for continuous reporting of data. This is an “asynchronous” mechanism, so for example, the device can use it to send data up to the host, regarding changes in state as those changes occur.
|Header||hidport.h (include Hidport.h)|