HidD_SetOutputReport-Funktion (hidsdi.h)

Artikel
03/01/2024

Die HidD_SetOutputReport Routine sendet einen Ausgabebericht an eine Sammlung der obersten Ebene.

Verwenden Sie diese Routine nur, um den aktuellen Zustand einer Auflistung festzulegen. Einige Geräte unterstützen diese Routine möglicherweise nicht und reagieren nicht mehr, wenn diese Routine verwendet wird. Weitere Informationen finden Sie unter Senden von HID-Berichten durch User-Mode Anwendungen.

Syntax

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

Parameter

[in] HidDeviceObject

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

[in] ReportBuffer

Zeiger auf einen vom Aufrufer zugewiesenen Ausgabeberichtspuffer, den der Aufrufer verwendet, um eine Berichts-ID anzugeben.

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 Ausgabebericht sowie ein zusätzliches Byte zu enthalten, das eine Nichtzero-Berichts-ID angibt. Wenn die Berichts-ID nicht verwendet wird, ist der ID-Wert 0.

Rückgabewert

Wenn HidD_SetOutputReport erfolgreich ist, wird TRUE zurückgegeben. Andernfalls wird FALSE zurückgegeben. Verwenden Sie GetLastError , um erweiterte Fehlerinformationen abzurufen.

Hinweise

Die richtige ReportBufferLength wird durch das OutputReportByteLength-Element der HIDP_CAPS Struktur einer Auflistung der obersten Ebene angegeben, die von HidP_GetCaps Aufruf zurückgegeben wird.

Bevor die HidD_SetOutputReport-Routine aufgerufen wird, muss der Aufrufer Folgendes tun:

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 ReportBuffer-Parameter verweist auf den Ausgabebericht. Abhängig von der Berichts-ID bereitet der Aufrufer den Bericht vor, indem er eine der folgenden Funktionen aufruft:

Ein Beispiel zum Vorbereiten und Senden eines HID-Berichts an eine Sammlung der obersten Ebene finden Sie in der HClient-Beispielanwendung .

Nur Anwendungen im Benutzermodus können HidD_SetOutputReport aufrufen. Kernelmodustreiber können eine IOCTL_HID_SET_OUTPUT_REPORT Anforderung verwenden.

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