HidD_GetInputReport-Funktion (hidsdi.h)

Artikel
03/05/2024

Die HidD_GetInputReport Routine gibt einen Eingabebericht aus einer Auflistung der obersten Ebene zurück.

Verwenden Sie diese Routine nur, um den aktuellen Zustand einer Auflistung abzurufen. Wenn eine Anwendung versucht, diese Routine zum kontinuierlichen Abrufen von Eingabeberichten zu verwenden, können die Berichte verloren gehen. Weitere Informationen finden Sie unter Abrufen von HID-Berichten durch Benutzermodusanwendungen.

Syntax

BOOLEAN HidD_GetInputReport(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  ReportBuffer,
  [in]  ULONG  ReportBufferLength
);

Parameter

[in] HidDeviceObject

Ein geöffnetes Handle für eine Sammlung auf oberster Ebene.

[out] ReportBuffer

Zeiger auf einen vom Aufrufer zugewiesenen Eingabeberichtspuffer, den der Aufrufer zum Angeben einer HID-Berichts-ID verwendet und HidD_GetInputReport verwendet, um den angegebenen Eingabebericht zurückzugeben.

Weitere Informationen zu diesem Parameter finden Sie im Abschnitt Hinweise.

[in] ReportBufferLength

Die Größe des Berichtspuffers in Bytes. Der Berichtspuffer muss groß genug sein, um den Eingabebericht und ein zusätzliches Byte zu enthalten, das eine Berichts-ID angibt. Wenn die Berichts-ID nicht verwendet wird, ist der ID-Wert 0.

Rückgabewert

HidD_GetInputReport gibt TRUE zurück, wenn dies erfolgreich ist. Andernfalls wird FALSE zurückgegeben. Verwenden Sie GetLastError , um erweiterte Fehlerinformationen abzurufen.

Hinweise

Die richtige ReportBufferLength wird vom InputReportByteLength-Member der HIDP_CAPS Struktur einer Auflistung der obersten Ebene angegeben, die von HidP_GetCaps Aufruf zurückgegeben wird.

Bevor die HidD_GetInputReport-Routine aufgerufen wird, muss der Aufrufer Folgendes ausführen:

Wenn die Auflistung der obersten Ebene Berichts-IDs enthält, muss der Aufrufer das erste Byte des ReportBuffer-Parameters auf eine nichtzero-Berichts-ID festlegen.
Wenn die Auflistung der obersten Ebene keine Berichts-IDs enthält, muss der Aufrufer das erste Byte des ReportBuffer-Parameters auf 0 festlegen.

Der Eingabebericht wird im ReportBuffer-Parameter zurückgegeben. Abhängig von der Berichts-ID analysiert der Aufrufer den Bericht, indem er eine der folgenden Funktionen aufruft:

Ein Beispiel zum Analysieren eines HID-Berichts finden Sie in der HClient-Beispielanwendung .

Nur Anwendungen im Benutzermodus können HidD_GetInputReport aufrufen. Kernelmodustreiber können eine IOCTL_HID_GET_INPUT_REPORTAnforderung verwenden.

Weitere Informationen finden Sie unter Interpretieren von HID-Berichten.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows XP und höheren Versionen von Windows.
Zielplattform	Universell
Header	hidsdi.h (include Hidsdi.h)
Bibliothek	Hid.lib
DLL	Hid.dll

Freigeben über