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

2025-02-07

Подпрограмма 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 (include Hidsdi.h)
библиотеки	Hid.lib
DLL	Hid.dll