IOCTL_HID_GET_POLL_FREQUENCY_MSEC IOCTL

The IOCTL_HID_GET_POLL_FREQUENCY_MSEC request obtains the current polling frequency, in milliseconds, of a top-level collection.

For general information about HIDClass devices, see HID Collections.

Major Code

IRP_MJ_DEVICE_CONTROL

Input Buffer

Parameters.DeviceIoControl.OutputBufferLength in the I/O stack location of the IRP indicates the size, in bytes, of the output buffer, which must be >= sizeof(ULONG).

Input Buffer Length

Greater than or equal to sizeof(ULONG).

Output Buffer

Irp->AssociatedIrp.SystemBuffer points to a buffer that will receive the polling frequency.

Status Block

The HID class driver sets the following fields of Irp->IoStatus:

  • Information is set to sizeof(ULONG) if the polling frequency is successfully retrieved.
  • Status is set to STATUS_SUCCESS if the transfer completed without error. Otherwise, it is set to an appropriate NTSTATUS error code.

Requirements

   
Header hidclass.h (include Hidclass.h)

See Also

IOCTL_HID_SET_POLL_FREQUENCY_MSEC