funzione HidD_GetProductString (hidsdi.h)
La routine HidD_GetProductString restituisce la stringa incorporata di una raccolta di primo livello che identifica il prodotto del produttore.
Sintassi
BOOLEAN HidD_GetProductString(
[in] HANDLE HidDeviceObject,
[out] PVOID Buffer,
[in] ULONG BufferLength
);
Parametri
[in] HidDeviceObject
Specifica un handle aperto a una raccolta di livello superiore.
[out] Buffer
Puntatore a un buffer allocato dal chiamante usato dalla routine per restituire la stringa di prodotto richiesta. La routine restituisce una stringa di caratteri wide con terminazione NULL.
[in] BufferLength
Specifica la lunghezza, in byte, di un buffer allocato dal chiamante fornito in Buffer. Se il buffer non è abbastanza grande per restituire l'intera stringa incorporata con terminazione NULL, la routine restituisce nulla nel buffer. Il buffer fornito deve essere <= 4093 byte (2^12 - 3).
Valore restituito
HidD_GetProductString restituisce TRUE se restituisce correttamente l'intera stringa incorporata con terminazione NULL. In caso contrario, la routine restituisce FALSE. Usare GetLastError per ottenere informazioni sull'errore estese.
Commenti
Solo le applicazioni in modalità utente possono chiamare HidD_GetProductString. I driver in modalità kernel possono usare una richiesta di IOCTL_HID_GET_PRODUCT_STRING .
Il numero massimo possibile di caratteri in una stringa incorporata è specifico del dispositivo. Per i dispositivi USB, la lunghezza massima della stringa è di 126 caratteri wide (non incluso il carattere NULL terminante).
Il membro iProduct di una struttura USB_DEVICE_DESCRIPTOR per un'interfaccia specifica è impostato dal driver padre generico della classe comune USB in base alle regole seguenti:
Se il membro iInterface della struttura USB_INTERFACE_DESCRIPTOR per l'interfaccia è diverso da zero, il membro iProduct della struttura di USB_DEVICE_DESCRIPTOR per l'interfaccia è impostato sul membro iInterface della struttura USB_INTERFACE_DESCRIPTOR.
Se l'interfaccia viene raggruppata da un descrittore dell'associazione di interfaccia USB e dal membro iFunction del descrittore dell'associazione di interfaccia per l'interfaccia è diverso da zero, il membro iProduct della struttura di USB_DEVICE_DESCRIPTOR per l'interfaccia è impostato sul membro iFunction del descrittore dell'associazione di interfaccia.
Se il buffer fornito non <è = 4093 byte (2^12 - 3) la chiamata potrebbe non riuscire (a seconda del protocollo sottostante, HID/Bluetooth/SPI) con codice di errore ERROR_GEN_FAILURE (0x0000001f)
Per altre informazioni, vedere Raccolte HID.
Requisiti
| Requisito | Valore |
|---|---|
| Client minimo supportato | Disponibile in Windows 2000 e versioni successive di Windows. |
| Piattaforma di destinazione | Universale |
| Intestazione | hidsdi.h (include Hidsdi.h) |
| Libreria | Hid.lib |
| DLL | Hid.dll |