HidD_GetProductString (hidsdi.h)

Artikel
02/29/2024

Rutinitas HidD_GetProductString mengembalikan string yang disematkan dari koleksi tingkat atas yang mengidentifikasi produk produsen.

Sintaks

BOOLEAN HidD_GetProductString(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  Buffer,
  [in]  ULONG  BufferLength
);

Parameter

[in] HidDeviceObject

Menentukan handel terbuka ke koleksi tingkat atas.

[out] Buffer

Arahkan ke buffer yang dialokasikan pemanggil yang digunakan rutinitas untuk mengembalikan string produk yang diminta. Rutinitas mengembalikan string karakter lebar yang dihentikan NULL.

[in] BufferLength

Menentukan panjang, dalam byte, dari buffer yang dialokasikan pemanggil yang disediakan di Buffer. Jika buffer tidak cukup besar untuk mengembalikan seluruh string tersemat yang dihentikan NULL, rutinitas tidak mengembalikan apa pun di buffer. Buffer yang disediakan harus <= 4093 byte (2^12 – 3).

Nilai kembali

HidD_GetProductString mengembalikan TRUE jika berhasil mengembalikan seluruh string tersemat yang dihentikan NULL. Jika tidak, rutinitas mengembalikan FALSE. Gunakan GetLastError untuk mendapatkan informasi kesalahan yang diperluas.

Keterangan

Hanya aplikasi mode pengguna yang dapat memanggil HidD_GetProductString. Driver mode kernel dapat menggunakan permintaan IOCTL_HID_GET_PRODUCT_STRING .

Jumlah karakter maksimum yang mungkin dalam string yang disematkan adalah spesifik perangkat. Untuk perangkat USB, panjang string maksimum adalah 126 karakter lebar (tidak termasuk karakter NULL yang mengakhiri).

Anggota iProduct dari struktur USB_DEVICE_DESCRIPTOR untuk antarmuka tertentu diatur oleh driver induk generik kelas umum USB berdasarkan aturan berikut:

Jika anggota iInterface dari struktur USB_INTERFACE_DESCRIPTOR untuk antarmuka bukan nol, anggota iProduct dari struktur USB_DEVICE_DESCRIPTOR untuk antarmuka diatur ke anggota iInterface dari struktur USB_INTERFACE_DESCRIPTOR.
Jika antarmuka dikelompokkan menurut deskriptor asosiasi antarmuka USB dan anggota iFunction dari deskriptor asosiasi antarmuka untuk antarmuka bukan nol, anggota iProduct dari struktur USB_DEVICE_DESCRIPTOR untuk antarmuka diatur ke anggota iFunction dari deskriptor asosiasi antarmuka.

Jika buffer yang disediakan tidak <= 4093 byte (2^12 – 3) panggilan mungkin gagal (tergantung pada protokol yang mendasar, HID/Bluetooth/SPI) dengan kode kesalahan ERROR_GEN_FAILURE (0x0000001f)

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	hidsdi.h (termasuk Hidsdi.h)
Pustaka	Hid.lib
DLL	Hid.dll