fungsi HidD_GetInputReport (hidsdi.h)

Artikel
03/08/2023

Rutinitas HidD_GetInputReport mengembalikan laporan input dari koleksi tingkat atas.

Hanya gunakan rutinitas ini untuk mendapatkan status koleksi saat ini. Jika aplikasi mencoba menggunakan rutinitas ini untuk terus mendapatkan laporan input, laporan dapat hilang. Untuk informasi selengkapnya, lihat Mendapatkan Laporan HID oleh aplikasi mode pengguna.

Sintaks

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

Parameter

[in] HidDeviceObject

Handel terbuka ke koleksi tingkat atas.

[out] ReportBuffer

Penunjuk ke buffer laporan input yang dialokasikan penelepon yang digunakan pemanggil untuk menentukan ID laporan HID dan HidD_GetInputReport menggunakan untuk mengembalikan laporan input yang ditentukan.

Untuk informasi selengkapnya tentang parameter ini, lihat bagian Keterangan.

[in] ReportBufferLength

Ukuran buffer laporan dalam byte. Buffer laporan harus cukup besar untuk menyimpan laporan input ditambah satu byte tambahan yang menentukan ID laporan. Jika ID laporan tidak digunakan, nilai ID adalah nol.

Nilai kembali

HidD_GetInputReport mengembalikan TRUE jika berhasil; jika tidak, ia mengembalikan FALSE. Gunakan GetLastError untuk mendapatkan informasi kesalahan yang diperluas.

Keterangan

ReportBufferLength yang benar ditentukan oleh anggota InputReportByteLength dari struktur HIDP_CAPS koleksi tingkat atas yang dikembalikan dari panggilan HidP_GetCaps.

Sebelum memanggil rutinitas HidD_GetInputReport , pemanggil harus melakukan hal berikut:

Jika koleksi tingkat atas menyertakan ID laporan, pemanggil harus mengatur byte pertama parameter ReportBuffer ke ID laporan bukan nol.
Jika koleksi tingkat atas tidak menyertakan ID laporan, pemanggil harus mengatur byte pertama dari parameter ReportBuffer ke nol.

Laporan input dikembalikan dalam parameter ReportBuffer . Bergantung pada ID laporan, pemanggil mengurai laporan dengan memanggil salah satu fungsi berikut:

Untuk contoh cara mengurai laporan HID, lihat aplikasi sampel HClient .

Hanya aplikasi mode pengguna yang dapat memanggil HidD_GetInputReport. Driver mode kernel dapat menggunakan permintaan IOCTL_HID_GET_INPUT_REPORT.

Untuk informasi selengkapnya, lihat Menginterpretasikan Laporan HID.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows XP dan versi Windows yang lebih baru.
Target Platform	Universal
Header	hidsdi.h (termasuk Hidsdi.h)
Pustaka	Hid.lib
DLL	Hid.dll

Bagikan melalui