функция HidD_GetSerialNumberString (hidsdi.h)

Подпрограмма HidD_GetSerialNumberString возвращает внедренную строку коллекции верхнего уровня , которая определяет серийный номер физического устройства коллекции.

Синтаксис

BOOLEAN HidD_GetSerialNumberString(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  Buffer,
  [in]  ULONG  BufferLength
);

Параметры

[in] HidDeviceObject

Указывает открытый дескриптор для коллекции верхнего уровня.

[out] Buffer

Указатель на буфер, выделенный вызывающим объектом, который подпрограмма использует для возврата запрошенной строки серийного номера. Подпрограмма возвращает строку расширенных символов с завершением NULL.

[in] BufferLength

Указывает длину буфера, выделенного вызывающим объектом, в байтах, предоставленного в буфере. Если буфер недостаточно велик для возврата всей встроенной строки, завершаемой значением NULL, подпрограмма не возвращает ничего в буфере. Предоставленный буфер должен быть <= 4093 байта (2^12–3).

Возвращаемое значение

HidD_GetSerialNumberString возвращает значение TRUE , если возвращается вся строка, завершающаяся null. В противном случае подпрограмма возвращает значение FALSE. Используйте GetLastError для получения расширенных сведений об ошибке.

Комментарии

Только приложения в пользовательском режиме могут вызывать HidD_GetSerialNumberString. Драйверы в режиме ядра могут использовать IOCTL_HID_GET_SERIALNUMBER_STRING.

Максимально возможное количество символов во внедренной строке зависит от устройства. Для USB-устройств максимальная длина строки составляет 126 символов ширины (не включая завершающий символ NULL).

Если предоставленный буфер не <равен 4093 байтам (2^12–3), вызов может завершиться ошибкой (в зависимости от базового протокола HID/Bluetooth/SPI) с кодом ошибки ERROR_GEN_FAILURE (0x0000001f).

Дополнительные сведения см. в разделе Коллекции HID.

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows 2000 и более поздних версиях Windows.
Целевая платформа Универсальное
Верхняя часть hidsdi.h (включая Hidsdi.h)
Библиотека Hid.lib
DLL Hid.dll

См. также раздел

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