IOCTL_HID_GET_STRING control code
The IOCTL_HID_GET_STRING control code obtains a manufacturer ID, product ID, or serial number for a top-level collection.
Input Buffer
The driver calls IWDFRequest::GetDeviceIoControlParameters and provides the pOutBufferSize parameter to retrieve the size, in bytes, of the output buffer.
The driver retrieves the composite input value by calling IWDFIoRequest::GetInputMemory. The two most significant bytes contain the language ID of the string to be retrieved. For example, a value of 1033 indicates English. The two least significant bytes contain one of the following three constant values:
- HID_STRING_ID_IMANUFACTURER
- HID_STRING_ID_IPRODUCT
- HID_STRING_ID_ISERIALNUMBER
For more information about the composite value, see IOCTL_HID_GET_STRING.
Output Buffer
The driver calls IWDFIoRequest::GetOutputMemory to retrieve the output buffer and fills it with the retrieved string.
Output Buffer Length
The size of the buffer obtained by calling IWDFRequest::GetOutputMemory.
Status block
HID minidrivers that carry out the I/O request to the device must also:
- Call IWDFIoRequest::SetInformation with the number of bytes transferred from the device.
- Call IWDFIoRequest::Complete with S_OK to complete the request without error. Otherwise, set the appropriate HRESULT error code.
Requirements
Minimum UMDF version |
1.11 |
Header |
Hidport.h |
See also