fungsi HidP_GetUsageValue (hidpi.h)

Artikel
03/05/2024

HidP_GetUsageValue rutin mengekstrak data yang terkait dengan nilai kontrol HID yang cocok dengan kriteria pilihan dalam laporan HID.

Sintaks

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parameter

[in] ReportType

Menentukan nilai enumerator HIDP_REPORT_TYPE yang mengidentifikasi jenis laporan.

[in] UsagePage

Menentukan halaman penggunaan nilai.

[in] LinkCollection

Menentukan kumpulan tautan yang berisi nilai. Jika LinkCollection bukan nol, rutinitas hanya mencari penggunaan dalam koleksi tautan ini; jika tidak, jika LinkCollection adalah nol, rutin mencari penggunaan dalam koleksi tingkat atas yang terkait dengan PreparsedData.

[in] Usage

Menentukan penggunaan nilai.

[out] UsageValue

Penunjuk ke buffer di mana rutinitas mengembalikan data nilai.

[in] PreparsedData

Penunjuk ke data koleksi tingkat atas yang disiapkan.

[in] Report

Penunjuk ke laporan yang berisi nilai.

[in] ReportLength

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

Nilai kembali

HidP_GetUsageValue mengembalikan salah satu nilai status berikut:

Menampilkan kode	Deskripsi
HIDP_STATUS_SUCCESS	Rutinitas berhasil mengembalikan data nilai.
HIDP_INVALID_REPORT_LENGTH	Panjang laporan tidak valid.
HIDP_INVALID_REPORT_TYPE	Tipe laporan yang ditentukan tidak valid.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Koleksi berisi nilai 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 nilai pada halaman penggunaan yang ditentukan dalam laporan apa pun dari jenis laporan yang ditentukan.

Keterangan

HidP_GetUsageValue tidak menandatangani atau menskalakan nilai. Untuk mengekstrak nilai yang ditandatangani, gunakan HidP_GetScaledUsageValue. Untuk menetapkan bit tanda secara manual, posisi bit tanda dapat ditentukan dari informasi dalam struktur HIDP_VALUE_CAPS nilai.

HidP_GetUsageValue dirancang untuk mengekstrak nilai penggunaan untuk penggunaan yang jumlah laporannya adalah 1. Jika penggunaan yang ditentukan memiliki jumlah laporan yang lebih besar dari 1, penggunaannya adalah bagian dari array nilai penggunaan. HidP_GetUsageValue hanya mengembalikan item data pertama dalam array nilai penggunaan. Untuk mengekstrak semua item data dalam array nilai penggunaan, gunakan HidP_GetUsageValueArray.

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