HidP_GetUsages (hidpi.h)

Artikel
08/07/2023

Rutinitas HidP_GetUsages mengembalikan daftar semua penggunaan tombol kontrol HID yang ada di halaman penggunaan tertentu dan diatur ke AKTIF dalam laporan HID.

Sintaks

NTSTATUS HidP_GetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [out]     PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [out]     PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameter

[in] ReportType

Menentukan nilai enumerator HIDP_REPORT_TYPE yang mengidentifikasi jenis laporan.

[in] UsagePage

Menentukan halaman penggunaan penggunaan tombol. Rutinitas hanya mengembalikan informasi tentang tombol pada halaman penggunaan ini.

[in] LinkCollection

Menentukan kumpulan tautan penggunaan tombol. Jika LinkCollection bukan nol, rutinitas hanya mengembalikan informasi tentang tombol yang dimuat koleksi tautan ini; jika tidak, jika LinkCollection adalah nol, rutin mengembalikan informasi tentang semua tombol dalam koleksi tingkat atas yang terkait dengan PreparsedData.

[out] UsageList

Arahkan ke buffer yang dialokasikan penelepon yang digunakan rutin untuk mengembalikan penggunaan semua tombol yang diatur ke AKTIF dan termasuk dalam halaman penggunaan yang ditentukan oleh UsagePage.

[in, out] UsageLength

Menentukan, pada input, panjang, dalam elemen array, dari buffer UsageList . Menentukan, pada output, jumlah tombol yang diatur ke AKTIF pada halaman penggunaan yang ditentukan.

[in] PreparsedData

Penunjuk ke data koleksi tingkat atas yang telah disiapkan.

[out] Report

Penunjuk ke laporan.

[in] ReportLength

Menentukan panjang, dalam byte, dari laporan yang terletak di Laporan.

Menampilkan nilai

HidP_GetUsages mengembalikan salah satu nilai status berikut:

Menampilkan kode	Deskripsi
HIDP_STATUS_SUCCESS	Rutinitas berhasil mengembalikan semua penggunaan tombol yang diatur ke AKTIF.
HIDP_INVALID_REPORT_LENGTH	Panjang laporan tidak valid.
HIDP_INVALID_REPORT_TYPE	Tipe laporan yang ditentukan tidak valid.
HIDP_STATUS_BUFFER_TOO_SMALL	Buffer UsageList terlalu kecil untuk menahan semua penggunaan yang saat ini diatur ke AKTIF pada halaman penggunaan yang ditentukan.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Koleksi berisi tombol pada halaman penggunaan yang ditentukan dalam laporan jenis yang ditentukan, tetapi tidak ada penggunaan tersebut dalam laporan yang ditentukan.
HIDP_STATUS_INVALID_PREPARSED_DATA	Data yang disiapkan tidak valid.
HIDP_STATUS_USAGE_NOT_FOUND	Koleksi tidak berisi tombol apa pun pada halaman penggunaan yang ditentukan dalam laporan apa pun dari jenis laporan yang ditentukan.

Keterangan

Aplikasi mode pengguna dan driver mode kernel memanggil HidP_MaxUsageListLength untuk menentukan jumlah maksimum tombol yang dapat dikembalikan untuk jenis laporan tertentu. Atau, aplikasi atau driver dapat memanggil HidP_GetUsages dan mengatur (*UsageLength) ke nol untuk mengembalikan panjang yang diperlukan dalam UsageLength. Dengan kata lain, UsageLength harus menjadi penunjuk yang valid yang menunjuk ke nilai ULONG 0 untuk mendapatkan panjang yang diperlukan.

Aplikasi atau driver menentukan panjang laporan yang diperlukan dari anggota XxxReportByteLength dalam struktur HIDP_CAPS koleksi tingkat atas.

Untuk informasi selengkapnya, lihat Koleksi HID.

Persyaratan


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