Export (0) Print
Expand All

HidD_GetSerialNumberString routine

The HidD_GetSerialNumberString routine returns the embedded string of a top-level collection that identifies the serial number of the collection's physical device.

Syntax


BOOLEAN __stdcall HidD_GetSerialNumberString(
  _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 requested serial number string. The routine returns a NULL-terminated wide character string.

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_GetSerialNumberString returns TRUE if it successfully returns the entire NULL-terminated embedded string. Otherwise, the routine returns FALSE.

Remarks

Only user-mode applications can call HidD_GetSerialNumberString. Kernel-mode drivers can use IOCTL_HID_GET_SERIALNUMBER_STRING.

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

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidsdi.h (include Hidsdi.h)

Library

Hid.lib

See also

HidD_GetManufacturerString
HidD_GetPhysicalDescriptor
HidD_GetProductString
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:
© 2014 Microsoft