fungsi HidP_GetData (hidpi.h)

  • Artikel

HidP_GetData rutin mengembalikan, untuk laporan tertentu, array struktur HIDP_DATA yang mengidentifikasi indeks data dari semua tombol kontrol HID yang saat ini diatur ke ON (1), dan indeks data dan data yang terkait dengan semua nilai kontrol HID.

Sintaks

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameter

[in] ReportType

Menentukan nilai enumerator HIDP_REPORT_TYPE yang menunjukkan jenis laporan HID yang terletak di Laporan.

[out] DataList

Menentukan array struktur HIDP_DATA yang dialokasikan penelepon yang digunakan rutin untuk mengembalikan informasi tentang semua tombol yang saat ini diatur ke AKTIF dan data yang terkait dengan nilai.

[in, out] DataLength

Menentukan, pada input, jumlah struktur yang dipegang oleh array DataList yang dialokasikan pemanggil. Menentukan, pada output, jumlah kontrol yang rutinnya dapat mengembalikan data, yang mencakup semua tombol yang saat ini diatur ke AKTIF dan semua nilai kontrol.

[in] PreparsedData

Arahkan ke data yang disiapkan dari koleksi tingkat atas yang terkait dengan laporan HID yang terletak di Laporan.

[in] Report

Penunjuk ke laporan HID.

[in] ReportLength

Menentukan ukuran, dalam byte, dari laporan HID yang terletak di Laporan, yang harus sama dengan panjang laporan untuk jenis laporan yang ditentukan yang dikembalikan oleh HidP_GetCaps dalam struktur HIDP_CAPS koleksi.

Nilai kembali

HidP_GetData mengembalikan salah satu nilai status berikut:

Menampilkan kode Deskripsi
HIDP_STATUS_SUCCESS
 Semua data kontrol berhasil dikembalikan.
HIDP_STATUS_INVALID_REPORT_TYPE
 Tipe laporan yang ditentukan oleh ReportType tidak valid
HIDP_STATUS_INVALID_PREPARSED_DATA
 Data yang disiapkan yang ditentukan oleh PreparsedData tidak valid
HIDP_STATUS_INVALID_REPORT_LENGTH
 Ukuran, dalam byte, dari laporan HID tidak sama dengan panjang yang ditentukan dalam struktur HIDP_CAPS koleksi untuk jenis laporan yang ditentukan.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 Koleksi tingkat atas tidak memiliki laporan jenis yang ditentukan.
HIDP_STATUS_BUFFER_TOO_SMALL
 Array DataList terlalu kecil untuk menjelaskan semua tombol, saat ini diatur ke AKTIF, dan semua nilai dalam laporan HID.

Keterangan

Aplikasi mode pengguna dan driver mode kernel memanggil HidP_MaxDataListLength untuk menentukan jumlah maksimum kemungkinan struktur HIDP_DATA yang dapat dikembalikan HidP_GetData .

HidP_GetData tidak mengembalikan data untuk array nilai penggunaan.

Untuk informasi selengkapnya, lihat Koleksi HID.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Tersedia di Windows 2000 dan versi Windows yang lebih baru.
Target Platform Universal
Header hidpi.h (termasuk Hidpi.h)
Pustaka Hidparse.lib
IRQL <= DISPATCH_LEVEL

Lihat juga

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA