HidP_GetButtonCaps (hidpi.h)
Rutinitas HidP_GetButtonCaps mengembalikan array kemampuan tombol yang menjelaskan semua tombol kontrol HID dalam koleksi tingkat atas untuk jenis laporan HID tertentu.
Sintaks
NTSTATUS HidP_GetButtonCaps(
[in] HIDP_REPORT_TYPE ReportType,
[out] PHIDP_BUTTON_CAPS ButtonCaps,
[in, out] PUSHORT ButtonCapsLength,
[in] PHIDP_PREPARSED_DATA PreparsedData
);
Parameter
[in] ReportType
Menentukan nilai enumerator HIDP_REPORT_TYPE yang mengidentifikasi jenis laporan.
[out] ButtonCaps
Penunjuk ke buffer yang dialokasikan pemanggil yang digunakan rutinitas untuk mengembalikan array kemampuan tombol untuk jenis laporan yang ditentukan.
[in, out] ButtonCapsLength
Menentukan panjang input, dalam elemen array, dari buffer yang disediakan di ButtonCaps. Pada output, parameter ini diatur ke jumlah elemen aktual yang dikembalikan rutinitas.
[in] PreparsedData
Penunjuk ke data koleksi tingkat atas yang telah disiapkan.
Nilai kembali
HidP_GetButtonCaps mengembalikan salah satu nilai status berikut:
| Menampilkan kode | Deskripsi |
|---|---|
|
Rutinitas berhasil mengembalikan data kemampuan. |
|
Data yang disiapkan tidak valid. |
Keterangan
HidP_GetButtonCaps mengembalikan kemampuan semua tombol dalam koleksi tingkat atas untuk jenis laporan tertentu.
ButtonCapsLength harus diatur ke nilai anggota NumberXxxButtonCaps dari struktur HIDP_CAPS yang dikembalikan oleh HidP_GetCaps, di mana Xxx menentukan jenis laporan.
Untuk mendapatkan subset kapabilitas tombol, yang dipilih oleh penggunaan, halaman penggunaan, atau kumpulan tautan, gunakan HidP_GetSpecificButtonCaps.
Untuk informasi selengkapnya tentang kemampuan koleksi, lihat Mendapatkan Informasi Koleksi.
Lihat juga 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 | PASSIVE_LEVEL |