HidD_GetProductString-Funktion (hidsdi.h)
Die HidD_GetProductString Routine gibt die eingebettete Zeichenfolge einer Auflistung der obersten Ebene zurück, die das Produkt des Herstellers identifiziert.
Syntax
BOOLEAN HidD_GetProductString(
[in] HANDLE HidDeviceObject,
[out] PVOID Buffer,
[in] ULONG BufferLength
);
Parameter
[in] HidDeviceObject
Gibt ein geöffnetes Handle für eine Auflistung der obersten Ebene an.
[out] Buffer
Zeiger auf einen vom Aufrufer zugewiesenen Puffer, den die Routine verwendet, um die angeforderte Produktzeichenfolge zurückzugeben. Die Routine gibt eine MIT NULL beendete breite Zeichenfolge zurück.
[in] BufferLength
Gibt die Länge eines vom Aufrufer zugewiesenen Puffers in Bytes an, der bei Buffer bereitgestellt wird. Wenn der Puffer nicht groß genug ist, um die gesamte eingebettete NULL-Zeichenfolge zurückzugeben, gibt die Routine nichts im Puffer zurück. Der bereitgestellte Puffer muss = 4093 Bytes (2^12 – 3) sein <.
Rückgabewert
HidD_GetProductString gibt TRUE zurück, wenn die gesamte eingebettete NULL-Zeichenfolge erfolgreich zurückgegeben wird. Andernfalls gibt die Routine FALSE zurück. Verwenden Sie GetLastError , um erweiterte Fehlerinformationen abzurufen.
Hinweise
Nur Anwendungen im Benutzermodus können HidD_GetProductString aufrufen. Kernelmodustreiber können eine IOCTL_HID_GET_PRODUCT_STRING-Anforderung verwenden.
Die maximal mögliche Anzahl von Zeichen in einer eingebetteten Zeichenfolge ist gerätespezifisch. Für USB-Geräte beträgt die maximale Zeichenfolgenlänge 126 breite Zeichen (ohne das beendende NULL-Zeichen).
Das iProduct-Element einer USB_DEVICE_DESCRIPTOR-Struktur für eine bestimmte Schnittstelle wird vom generischen übergeordneten USB-Klassentreiber der allgemeinen USB-Klasse basierend auf den folgenden Regeln festgelegt:
Wenn das iInterface-Element der USB_INTERFACE_DESCRIPTOR-Struktur für die Schnittstelle nichtzero ist, wird das iProduct-Element der USB_DEVICE_DESCRIPTOR-Struktur für die Schnittstelle auf das iInterface-Element der USB_INTERFACE_DESCRIPTOR-Struktur festgelegt.
Wenn die Schnittstelle nach einem USB-Schnittstellenzuordnungsdeskriptor gruppiert ist und der iFunction-Member des Schnittstellenzuordnungsdeskriptors für die Schnittstelle nonzero ist, wird das iProduct-Element der USB_DEVICE_DESCRIPTOR-Struktur für die Schnittstelle auf das iFunction-Element des Schnittstellenzuordnungsdeskriptors festgelegt.
Wenn der angegebene Puffer nicht <= 4093 Bytes (2^12 – 3) ist, kann der Aufruf (abhängig vom zugrunde liegenden Protokoll HID/Bluetooth/SPI) mit Fehlercode ERROR_GEN_FAILURE (0x0000001f) fehlschlagen.
Weitere Informationen finden Sie unter HID-Sammlungen.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Verfügbar in Windows 2000 und höheren Versionen von Windows. |
| Zielplattform | Universell |
| Header | hidsdi.h (include Hidsdi.h) |
| Bibliothek | Hid.lib |
| DLL | Hid.dll |