HidP_GetSpecificButtonCaps (hidpi.h)

Artikel
08/07/2023

Rutinitas HidP_GetSpecificButtonCaps mengembalikan array kemampuan tombol yang menjelaskan semua tombol kontrol HID dalam koleksi tingkat atas yang memenuhi kriteria pilihan tertentu.

Sintaks

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [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.

[in] UsagePage

Menentukan halaman penggunaan sebagai kriteria pencarian. Jika UsagePage bukan nol, hanya tombol yang menentukan halaman penggunaan ini yang dikembalikan.

[in] LinkCollection

Menentukan kumpulan tautan sebagai kriteria pencarian. Jika LinkCollection bukan nol, hanya tombol yang merupakan bagian dari koleksi tautan ini yang dikembalikan.

[in] Usage

Menentukan penggunaan HID sebagai kriteria pencarian. Jika Penggunaan bukan nol, hanya tombol yang menentukan penggunaan ini yang akan dikembalikan.

[out] ButtonCaps

Penunjuk ke buffer yang dialokasikan penelepon di mana rutinitas 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 yang benar-benar dikembalikan rutinitas.

[in] PreparsedData

Penunjuk ke data koleksi tingkat atas yang disiapkan.

Nilai kembali

HidP_GetSpecificButtonCaps mengembalikan salah satu nilai status berikut:

Menampilkan kode	Deskripsi
HIDP_STATUS_SUCCESS	Rutinitas berhasil mengembalikan data kemampuan.
HIDP_STATUS_INVALID_PREPARSED_DATA	Data yang disiapkan tidak valid.

Keterangan

Ukuran array ButtonCaps yang diperlukan ditentukan oleh anggota NumberXxxButtonCaps dari struktur HIDP_CAPS koleksi tingkat atas.

Saat memanggil HidP_GetSpecificButtonCaps, menentukan nol untuk UsagePage, Usage, dan LinkCollection setara dengan memanggil HidP_GetButtonCaps.

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

Lihat juga