Fungsi GetRawInputDeviceInfoA (winuser.h)

Artikel
07/16/2024

Mengambil informasi tentang perangkat input mentah.

Sintaksis

UINT GetRawInputDeviceInfoA(
  [in, optional]      HANDLE hDevice,
  [in]                UINT   uiCommand,
  [in, out, optional] LPVOID pData,
  [in, out]           PUINT  pcbSize
);

Parameter

[in, optional] hDevice

Jenis: HANDLE

Handel ke perangkat input mentah. Ini berasal dari hDevice anggota RAWINPUTHEADER atau dari GetRawInputDeviceList.

[in] uiCommand

Jenis: UINT

Menentukan data apa yang akan dikembalikan dalam pData. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Arti
RIDI_PREPARSEDDATA 0x20000005	pData adalah penunjuk PHIDP_PREPARSED_DATA ke buffer untuk data kumpulan yang disiapkan.
RIDI_DEVICENAME 0x20000007	pData menunjuk ke string yang berisi nama antarmuka perangkat . Jika perangkat ini dibuka dengan Mode Akses Bersama maka Anda dapat memanggil CreateFile dengan nama ini untuk membuka koleksi HID dan menggunakan handel yang dikembalikan untuk memanggil ReadFile untuk membaca laporan input dan WriteFile untuk mengirim laporan output. Untuk informasi selengkapnya, lihat Membuka Koleksi HID dan Menangani Laporan HID. Untuk uiCommand ini saja, nilai dalam pcbSize adalah jumlah karakter (bukan jumlah byte).
RIDI_DEVICEINFO 0x2000000b	pData menunjuk ke struktur RID_DEVICE_INFO.

Nilai

Arti

RIDI_PREPARSEDDATA
0x20000005

pData adalah penunjuk PHIDP_PREPARSED_DATA ke buffer untuk data kumpulan yang disiapkan.

RIDI_DEVICENAME
0x20000007

pData menunjuk ke string yang berisi nama antarmuka perangkat .

Jika perangkat ini dibuka dengan Mode Akses Bersama maka Anda dapat memanggil CreateFile dengan nama ini untuk membuka koleksi HID dan menggunakan handel yang dikembalikan untuk memanggil ReadFile untuk membaca laporan input dan WriteFile untuk mengirim laporan output.

Untuk informasi selengkapnya, lihat Membuka Koleksi HID dan Menangani Laporan HID.

Untuk uiCommand ini saja, nilai dalam pcbSize adalah jumlah karakter (bukan jumlah byte).

RIDI_DEVICEINFO
0x2000000b

pData menunjuk ke struktur RID_DEVICE_INFO.

[in, out, optional] pData

Jenis: LPVOID

Penunjuk ke buffer yang berisi informasi yang ditentukan oleh uiCommand.

Jika uiCommand RIDI_DEVICEINFO, atur cbSize anggota RID_DEVICE_INFO ke sizeof(RID_DEVICE_INFO) sebelum memanggil GetRawInputDeviceInfo.

[in, out] pcbSize

Jenis: PUINT

Ukuran, dalam byte, data dalam pData.

Mengembalikan nilai

Jenis: UINT

Jika berhasil, fungsi ini mengembalikan angka non-negatif yang menunjukkan jumlah byte yang disalin ke pData.

Jika pData tidak cukup besar untuk data, fungsi mengembalikan -1. Jika pDatanull, fungsi mengembalikan nilai nol. Dalam kedua kasus ini, pcbSize diatur ke ukuran minimum yang diperlukan untuk pData buffer.

Panggil GetLastError untuk mengidentifikasi kesalahan lainnya.

Komentar

Nota

Header winuser.h mendefinisikan GetRawInputDeviceInfo sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosem UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Platform Target	Windows
Header	winuser.h (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll
set API	ext-ms-win-ntuser-rawinput-l1-1-0 (diperkenalkan di Windows 10, versi 10.0.14393)