IOCTL_HID_GET_COLLECTION_INFORMATION control code

The IOCTL_HID_GET_COLLECTION_INFORMATION request obtains a top-level collection's HID_COLLECTION_INFORMATION structure. This information includes the size, in bytes, of a collection's preparsed data.

For general information about HIDClass devices, see HID Collections.

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(HID_COLLECTION_INFORMATION).

Input Buffer Length

Greater than or equal to sizeof(HID_COLLECTION_INFORMATION).

Output Buffer

Irp->AssociatedIrp.SystemBuffer points to a buffer that will receive the collection information. This data will be formatted in the requester-supplied buffer as a HID_COLLECTION_INFORMATION structure.

Output Buffer Length

The size of a HID_COLLECTION_INFORMATION structure.

Status block

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

  • Information is set to sizeof(HID_COLLECTION_INFORMATION) if the data was retrieved successfully.

  • 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

HID_COLLECTION_INFORMATION

 

 

Send comments about this topic to Microsoft

Show: