función HidD_GetSerialNumberString (hidsdi.h)

Artículo
08/07/2023

La rutina HidD_GetSerialNumberString devuelve la cadena incrustada de una colección de nivel superior que identifica el número de serie del dispositivo físico de la colección.

Sintaxis

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

Parámetros

[in] HidDeviceObject

Especifica un identificador abierto para una colección de nivel superior.

[out] Buffer

Puntero a un búfer asignado por el autor de la llamada que la rutina usa para devolver la cadena de número de serie solicitada. La rutina devuelve una cadena de caracteres anchos terminada en NULL.

[in] BufferLength

Especifica la longitud, en bytes, de un búfer asignado por el autor de la llamada proporcionado en Buffer. Si el búfer no es lo suficientemente grande como para devolver toda la cadena insertada terminada en NULL, la rutina no devuelve nada en el búfer. El búfer proporcionado debe ser <= 4093 bytes (2^12 – 3).

Valor devuelto

HidD_GetSerialNumberString devuelve TRUE si devuelve correctamente la cadena incrustada terminada en NULL completa. De lo contrario, la rutina devuelve FALSE. Use GetLastError para obtener información de error extendida.

Comentarios

Solo las aplicaciones en modo de usuario pueden llamar a HidD_GetSerialNumberString. Los controladores en modo kernel pueden usar IOCTL_HID_GET_SERIALNUMBER_STRING.

El número máximo posible de caracteres en una cadena incrustada es específico del dispositivo. En el caso de los dispositivos USB, la longitud máxima de la cadena es de 126 caracteres anchos (sin incluir el carácter NULL de terminación).

Si el búfer proporcionado no <es = 4093 bytes (2^12 – 3), la llamada puede producir un error (según el protocolo subyacente, HID/Bluetooth/SPI) con código de error ERROR_GEN_FAILURE (0x0000001f)

Para obtener más información, vea Colecciones HID.

Requisitos

Requisito	Value
Cliente mínimo compatible	Disponible en Windows 2000 y versiones posteriores de Windows.
Plataforma de destino	Universal
Encabezado	hidsdi.h (include Hidsdi.h)
Library	Hid.lib
Archivo DLL	Hid.dll