IOCTL_HID_GET_INDEXED_STRING

IOCTL_HID_GET_INDEXED_STRING control code

The IOCTL_HID_GET_INDEXED_STRING request obtains a specified embedded string for a top-level collection. The retrieved string is a NULL-terminated wide character string in a human-readable format.

For general information about HIDClass devices, see HID Collections.

Input Parameters

IOCTL_HID_GET_INDEXED_STRING uses two input buffers.

Parameters.DeviceIoControl.OutputBufferLength in the I/O stack location of the IRP indicates the size, in bytes, of the output buffer at the location pointed to by Irp->MdlAddress. If the output buffer is not large enough to hold the entire NULL-terminated embedded string, the request returns nothing in the output buffer. 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).

Parameters.DeviceIoControl.Type3InputBuffer contains an INT value that describes the string to be retrieved. The most significant two bytes of the INT value contain the language ID (for example, a value of 1033 indicates English). The least significant two bytes of the INT value contain the string index.

Output Parameters

Irp->MdlAddress points to a buffer to receive the retrieved string (a NULL-terminated wide character string). Note that unlike most device control IRPs for HID minidrivers, this IRP does not use METHOD_NEITHER buffering. In particular, it must be distinguished from IOCTL_HID_GET_STRING whose output buffer is identified by Irp->UserBuffer.

I/O Status Block

The HID class driver sets 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.

Requirements

Header

Hidclass.h (include Hidclass.h)

See also

HidD_GetIndexedString
HidD_GetManufacturerString
HidD_GetProductString
HidD_GetSerialNumberString
IOCTL_HID_GET_INDEXED_STRING
IOCTL_HID_GET_MANUFACTURER_STRING
IOCTL_HID_GET_PRODUCT_STRING
IOCTL_HID_GET_SERIALNUMBER_STRING

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft