fungsi HidP_SetData (hidpi.h)

Artikel
08/07/2023

Rutinitas HidP_SetData menetapkan sekumpulan tombol kontrol HID dan penggunaan nilai tertentu dalam laporan HID.

Sintaks

NTSTATUS HidP_SetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in, out] PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameter

[in] ReportType

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

[in, out] DataList

Penunjuk ke array struktur HIDP_DATA yang dialokasikan penelepon yang menentukan tombol dan nilai penggunaan mana yang akan diatur.

[in, out] DataLength

Menentukan, pada input, jumlah anggota dalam array DataList . Untuk informasi tentang nilai output, lihat bagian Keterangan.

[in] PreparsedData

Penunjuk ke data tingkat atas yang telah disiapkan.

[in] 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 yang ditentukan yang HidP_GetCaps kembalikan dalam struktur HIDP_CAPS koleksi.

Nilai kembali

HidP_SetData mengembalikan HIDP_STATUS_SUCCESS jika berhasil mengatur semua data kontrol yang ditentukan oleh DataList.

HidP_SetData mengembalikan salah satu nilai status berikut jika salah satu parameter input tidak valid:

Menampilkan kode	Deskripsi
HIDP_STATUS_INVALID_PREPARSED_DATA	Data yang disiapkan yang ditentukan oleh PreparsedData tidak valid.
HIDP_STATUS_INVALID_REPORT_LENGTH	Ukuran, dalam byte, dari laporan HID tidak sama dengan panjang yang ditentukan dalam struktur HIDP_CAPS koleksi untuk jenis laporan yang ditentukan.
HIDP_STATUS_INVALID_REPORT_TYPE	ReportType tidak valid.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	Koleksi tidak berisi laporan tipe yang ditentukan.

HidP_SetData mengembalikan salah satu nilai kesalahan berikut jika salah satu nilai tombol atau penggunaan yang ditentukan tidak dapat diatur:

Menampilkan kode	Deskripsi
HIDP_STATUS_BUFFER_TOO_SMALL	Tombol dalam array tidak diatur ke AKTIF (1) karena semua bidang array sudah digunakan untuk mengindeks tombol lain.
HIDP_STATUS_BUTTON_NOT_PRESSED	Anggota DataList menentukan untuk mengatur tombol NONAKTIF (nol), tetapi tombol sudah diatur ke NONAKTIF.
HIDP_STATUS_DATA_INDEX_NOT_FOUND	Indeks data anggota DataList tidak valid.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Tombol atau nilai penggunaan terkandung dalam laporan, tetapi tidak ada dalam laporan yang ditentukan.
HIDP_STATUS_IS_VALUE_ARRAY	Indeks data menentukan array nilai penggunaan.

Keterangan

Kecuali untuk array nilai penggunaan, aplikasi mode pengguna atau driver mode kernel dapat menggunakan HidP_SetData untuk mengatur tombol dan nilai penggunaan dalam laporan. Untuk mengatur array nilai penggunaan, aplikasi atau driver harus menggunakan HidP_SetUsageValueArray.

HidP_SetData menetapkan nilai output DataLength sebagai berikut:

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	PASSIVE_LEVEL