SetupDiGetHwProfileListExW (setupapi.h)

Artikel
08/26/2023

Fungsi SetupDiGetHwProfileListEx mengambil daftar semua ID profil perangkat keras yang saat ini ditentukan di komputer lokal atau jarak jauh.

Sintaks

WINSETUPAPI BOOL SetupDiGetHwProfileListExW(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCWSTR MachineName,
                  PVOID  Reserved
);

Parameter

[out] HwProfileList

Penunjuk ke array untuk menerima daftar ID profil perangkat keras yang saat ini ditentukan.

[in] HwProfileListSize

Jumlah DWORD dalam buffer HwProfileList .

[out] RequiredSize

Pointer ke variabel jenis DWORD yang menerima jumlah profil perangkat keras yang saat ini ditentukan. Jika angka lebih besar dari HwProfileListSize, daftar dipotok agar sesuai dengan ukuran array. Nilai yang dikembalikan dalam RequiredSize menunjukkan ukuran array yang diperlukan untuk menyimpan seluruh daftar profil perangkat keras.

[out, optional] CurrentlyActiveIndex

Penunjuk ke variabel yang menerima indeks profil perangkat keras yang saat ini aktif dalam daftar profil perangkat keras yang diambil. Parameter ini bersifat opsional dan dapat berupa NULL.

[in, optional] MachineName

Penunjuk ke string yang dihentikan NULL yang berisi nama sistem jarak jauh untuk mengambil daftar ID profil perangkat keras. Parameter ini bersifat opsional dan dapat berupa NULL. Jika parameter ini NULL, daftar diambil untuk sistem lokal.

Perhatian

Menggunakan fungsi ini untuk mengakses komputer jarak jauh tidak didukung dimulai dengan Windows 8 dan Windows Server 2012, karena fungsi ini telah dihapus.

Reserved

Harus NULL.

Menampilkan nilai

Fungsi mengembalikan TRUE jika berhasil. Jika tidak, ia mengembalikan FALSE dan kesalahan yang dicatat dapat diambil dengan melakukan panggilan ke GetLastError. Jika ukuran yang diperlukan lebih besar dari HwProfileListSize, SetupDiGetHwProfileListEx mengembalikan FALSE dan panggilan ke GetLastError mengembalikan ERROR_INSUFFICIENT_BUFFER.

Keterangan

Catatan

Header setupapi.h mendefinisikan SetupDiGetHwProfileListEx sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor 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


Klien minimum yang didukung	Tersedia di Microsoft Windows 2000 dan versi Windows yang lebih baru.
Target Platform	Desktop
Header	setupapi.h (termasuk Setupapi.h)
Pustaka	Setupapi.lib

Lihat juga

SetupDiGetHwProfileFriendlyNameEx

Bagikan melalui