HidP_SetUsages (hidpi.h)

Artikel
03/05/2024

HidP_SetUsages rutin mengatur tombol kontrol HID tertentu AKTIF (1) dalam laporan HID.

Sintaks

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

Parameter

[in] ReportType

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

[in] UsagePage

Menentukan halaman penggunaan untuk penggunaan yang ditentukan oleh UsageList.

[in] LinkCollection

Menentukan kumpulan tautan yang berisi penggunaan. Jika LinkCollection bukan nol, rutinitas hanya mengatur penggunaan, jika ada, dalam koleksi tautan ini. Jika LinkCollection adalah nol, rutin mengatur penggunaan pertama untuk setiap penggunaan yang ditentukan dalam koleksi tingkat atas yang terkait dengan PreparsedData.

[in, out] UsageList

Arahkan ke array penggunaan.

[in, out] UsageLength

Menentukan, pada input, jumlah penggunaan dalam UsageList. Lihat bagian Keterangan untuk informasi tentang nilai output.

[in] PreparsedData

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

[in] Report

Penunjuk ke laporan.

[in] ReportLength

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

Nilai kembali

HidP_SetUsages mengembalikan salah satu nilai status berikut:

Menampilkan kode	Deskripsi
HIDP_STATUS_SUCCESS	Rutinitas berhasil menetapkan nilai penggunaan.
HIDP_STATUS_BUFFER_TOO_SMALL	Penggunaan dalam array tombol tidak dapat diatur karena array sudah sepenuhnya diatur.
HIDP_STATUS_INVALID_REPORT_LENGTH	Panjang laporan tidak valid.
HIDP_STATUS_INVALID_REPORT_TYPE	Tipe laporan yang ditentukan tidak valid.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Penggunaan tidak ada dalam laporan yang ditentukan, tetapi memang ada dalam laporan yang berbeda dari jenis yang ditentukan.
HIDP_STATUS_INVALID_PREPARSED_DATA	Data yang disiapkan tidak valid.
HIDP_STATUS_USAGE_NOT_FOUND	Penggunaan tidak ada dalam laporan apa pun dari jenis laporan yang ditentukan.

Keterangan

Jika HidP_SetUsages tidak dapat mengatur penggunaan dalam UsageList, rutin mengatur UsageLength ke indeks penggunaan yang tidak dapat diatur, dan mengembalikan nilai status yang menunjukkan kesalahan.

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