HidP_SetUsageValueArray (hidpi.h)

Rutinitas HidP_SetUsageValueArray menetapkan array nilai penggunaan kontrol HID dalam laporan HID tertentu.

Sintaks

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

Parameter

[in] ReportType

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

[in] UsagePage

Menentukan halaman penggunaan penggunaan.

[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 yang ditemukannya di koleksi tingkat atas yang terkait dengan PreparsedData.

[in] Usage

Menentukan penggunaan.

[in] UsageValue

Penunjuk ke buffer yang dialokasikan penelepon yang berisi data yang terkait dengan array nilai penggunaan.

[in] UsageValueByteLength

Menentukan panjang, dalam byte, dari buffer UsageValue .

[in] PreparsedData

Penunjuk ke data tingkat atas yang disiapkan.

[in, out] Report

Penunjuk ke laporan HID.

[in] ReportLength

Menentukan ukuran, dalam byte, dari laporan HID yang terletak di Laporan, yang harus sama dengan panjang laporan untuk jenis laporan tertentu yang HidP_GetCaps kembalikan dalam struktur HIDP_CAPS koleksi.

Nilai kembali

HidP_SetUsageValueArray mengembalikan salah satu nilai status berikut:

Menampilkan kode Deskripsi
HIDP_STATUS_SUCCESS
Rutinitas berhasil menetapkan nilai penggunaan.
HIDP_STATUS_INVALID_REPORT_LENGTH
Panjang laporan tidak valid.
HIDP_STATUS_INVALID_REPORT_TYPE
Tipe laporan yang ditentukan tidak valid.
HIDP_STATUS_BUFFER_TOO_SMALL
Ukuran, dalam byte, dari buffer UsageValue terlalu kecil.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID
Penggunaan tidak ada dalam laporan yang ditentukan, tetapi ada dalam laporan yang berbeda dari jenis yang ditentukan.
HIDP_STATUS_NOT_VALUE_ARRAY
Penggunaan yang ditentukan bukan array nilai penggunaan.
HIDP_STATUS_INVALID_PREPARSED_DATA
Data yang disiapkan tidak valid.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
Tidak ada laporan dari jenis yang ditentukan.
HIDP_STATUS_NOT_IMPLEMENTED
Ukuran laporan bidang data yang ditentukan untuk array nilai penggunaan bukan kelipatan delapan bit.
HIDP_STATUS_USAGE_NOT_FOUND
Penggunaan tidak ada dalam laporan apa pun dari jenis laporan yang ditentukan.

Keterangan

Ukuran yang diperlukan, dalam byte, dari buffer UsageValue ditentukan dengan mengalikan bersama-sama anggota BitSize dan ReportCount dari struktur HIDP_VALUE_CAPS array nilai penggunaan, dan membulatkan hasil hingga byte terdekat.

HidP_SetUsageValueArray hanya mendukung array nilai penggunaan di mana setiap bidang data array adalah kelipatan delapan bit.

Pemanggil harus mengatur buffer UsageValue persis seperti yang seharusnya terjadi dalam laporan.

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

Lihat juga

HidP_SetScaledUsageValue

HidP_SetUsageValue

_HIDP_PREPARSED_DATA