HidD_GetManufacturerString routine

The HidD_GetManufacturerString routine returns a top-level collection's embedded string that identifies the manufacturer.

Syntax

BOOLEAN __stdcall HidD_GetManufacturerString(
  _In_   HANDLE HidDeviceObject,
  _Out_  PVOID Buffer,
  _In_   ULONG BufferLength
);

Parameters

HidDeviceObject [in]

Specifies an open handle to a top-level collection.

Buffer [out]

Pointer to a caller-allocated buffer that the routine uses to return the collection's manufacturer string. The routine returns a NULL-terminated wide character string in a human-readable format.

BufferLength [in]

Specifies the length, in bytes, of a caller-allocated buffer provided at Buffer. If the buffer is not large enough to return the entire NULL-terminated embedded string, the routine returns nothing in the buffer.

Return value

HidD_HidD_GetManufacturerString returns TRUE if it returns the entire NULL-terminated embedded string. Otherwise, the routine returns FALSE.

Remarks

Only user-mode applications can call HidD_GetManufacturerString. Kernel-mode drivers can use an IOCTL_HID_GET_MANUFACTURER_STRING request.

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

For more information, see HID Collections.

Requirements

See also

HidD_GetIndexedString

HidD_GetPhysicalDescriptor

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

Build date: 10/26/2012