IOCTL_HID_GET_PRODUCT_STRING - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// hidclass.h

// CTL_CODE(0x000b, 0x06f, METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
#define IOCTL_HID_GET_PRODUCT_STRING 0x000B01BE
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (ni-hidclass-ioctl_hid_get_product_string)

IOCTL_HID_GET_PRODUCT_STRING IOCTL

Description

The IOCTL_HID_GET_PRODUCT_STRING request obtains a top-level collection's embedded string that identifies the manufacturer's product. The retrieved string is a NULL-terminated wide character string in a human-readable format.

For general information about HIDClass devices [HID Collections(/windows-hardware/drivers/hid/hid-collections).

Parameters

Major code

Input buffer

Parameters.DeviceIoControl.OutputBufferLength in the I/O stack location of the IRP indicates the size, in bytes, of the output buffer. If the output buffer is not large enough to hold the entire NULL-terminated embedded string, the request returns nothing in the output buffer.

Input buffer length

The maximum possible number of characters in an embedded string is device specific. For USB devices, the maximum string length is 126 wide characters (not including the terminating NULL character).

Output buffer

Irp->MdlAddress points to a buffer to receive the product ID string (a NULL-terminated wide character string).

Output buffer length

The length of a NULL-terminated wide character string. The supplied buffer must be <= 4093 bytes (2^12 – 3).

Input/output buffer

Input/output buffer length

Status block

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

See also

HidD_GetIndexedString

HidD_GetManufacturerString

HidD_GetPhysicalDescriptor

HidD_GetProductString

HidD_GetSerialNumberString

IOCTL_HID_GET_MANUFACTURER_STRING

IOCTL_HID_GET_PRODUCT_STRING

IOCTL_HID_GET_SERIALNUMBER_STRING