HidD_GetProductString función (hidsdi.h)
La rutina HidD_GetProductString devuelve la cadena incrustada de una colección de nivel superior que identifica el producto del fabricante.
Sintaxis
BOOLEAN HidD_GetProductString(
[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 producto 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 incrustada 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_GetProductString 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_GetProductString. Los controladores en modo kernel pueden usar una solicitud de IOCTL_HID_GET_PRODUCT_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).
El miembro iProduct de una estructura de USB_DEVICE_DESCRIPTOR para una interfaz determinada se establece mediante el controlador primario genérico de clase común USB basado en las reglas siguientes:
Si el miembro iInterface de la estructura de USB_INTERFACE_DESCRIPTOR para la interfaz es distinto de cero, el miembro iProduct de la estructura USB_DEVICE_DESCRIPTOR para la interfaz se establece en el miembro iInterface de la estructura USB_INTERFACE_DESCRIPTOR.
Si la interfaz se agrupa mediante un descriptor de asociación de interfaz USB y el miembro iFunction del descriptor de asociación de interfaz para la interfaz es distinto de cero, el miembro iProduct de la estructura USB_DEVICE_DESCRIPTOR de la interfaz se establece en el miembro iFunction del descriptor de asociación de interfaz.
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, consulte 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 |