HidD_GetProductString-Funktion (hidsdi.h)

Die HidD_GetProductString Routine gibt die eingebettete Zeichenfolge einer Auflistung auf oberster 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

Zeigen Sie auf einen vom Aufrufer zugewiesenen Puffer, den die Routine zum Zurückgeben der angeforderten Produktzeichenfolge verwendet. Die Routine gibt eine NULL-beendete breite Zeichenfolge zurück.

[in] BufferLength

Gibt die Länge eines vom Aufrufer zugewiesenen Puffers in Bytes an, der bei Bufferbereitgestellt 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 angegebene 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 zu erhalten.

Bemerkungen

Nur Benutzermodusanwendungen können HidD_GetProductStringaufrufen. 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. Bei USB-Geräten beträgt die maximale Zeichenfolgenlänge 126 breite Zeichen (nicht einschließlich des endenden NULL-Zeichens).

Das iProduct- Mitglied einer USB_DEVICE_DESCRIPTOR-Struktur für eine bestimmte Schnittstelle wird durch den allgemeinen übergeordneten USB-Treiber basierend auf den folgenden Regeln festgelegt:

• Wenn das iInterface Member der USB_INTERFACE_DESCRIPTOR Struktur für die Schnittstelle ungleich Null 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 durch einen USB-Schnittstellenzuordnungsdeskriptor gruppiert wird und das iFunction- Mitglied des Schnittstellenzuordnungsdeskriptors für die Schnittstelle ungleich Null ist, wird das iProduct- Mitglied der USB_DEVICE_DESCRIPTOR-Struktur für die Schnittstelle auf das iFunction Mitglied des Schnittstellenzuordnungsdeskriptors festgelegt.

Wenn der angegebene Puffer nicht <= 4093 Byte (2^12 – 3) schlägt der Aufruf möglicherweise fehl (je nach zugrunde liegendem Protokoll, HID/Bluetooth/SPI) mit Fehlercode ERROR_GEN_FAILURE (0x0000001f)

Weitere Informationen finden Sie unter HID Collections.

Anforderungen

Siehe auch

HidD_GetIndexedString

HidD_GetPhysicalDescriptor

HidD_GetSerialNumberString

IOCTL_HID_GET_INDEXED_STRING

IOCTL_HID_GET_MANUFACTURER_STRING

IOCTL_HID_GET_PRODUCT_STRING

IOCTL_HID_GET_SERIALNUMBER_STRING