SetupDiGetClassDevPropertySheetsA (setupapi.h)

Artikel
03/15/2023

Fungsi SetupDiGetClassDevPropertySheets mengambil handel ke lembar properti elemen informasi perangkat atau kelas penyiapan perangkat dari kumpulan informasi perangkat.

Sintaks

WINSETUPAPI BOOL SetupDiGetClassDevPropertySheetsA(
  [in]            HDEVINFO           DeviceInfoSet,
  [in, optional]  PSP_DEVINFO_DATA   DeviceInfoData,
  [in]            LPPROPSHEETHEADERA PropertySheetHeader,
  [in]            DWORD              PropertySheetHeaderPageListSize,
  [out, optional] PDWORD             RequiredSize,
  [in]            DWORD              PropertySheetType
);

Parameter

[in] DeviceInfoSet

Handel ke set informasi perangkat untuk mengembalikan handel lembar properti. Jika DeviceInfoData tidak menentukan elemen informasi perangkat dalam kumpulan informasi perangkat, kumpulan informasi perangkat harus memiliki kelas penyiapan perangkat terkait.

[in, optional] DeviceInfoData

Penunjuk ke struktur SP_DEVINFO_DATA yang menentukan elemen informasi perangkat di DeviceInfoSet.

Parameter ini bersifat opsional dan dapat berupa NULL. Jika parameter ini ditentukan, SetupDiGetClassDevPropertySheets mengambil handel lembar properti yang terkait dengan perangkat yang ditentukan. Jika parameter ini NULL, SetupDiGetClassDevPropertySheets mengambil handel lembar properti yang terkait dengan kelas penyiapan perangkat yang ditentukan di DeviceInfoSet.

[in] PropertySheetHeader

Penunjuk ke struktur PROPERTYSHEETHEADER. Lihat bagian Keterangan untuk informasi tentang array handel lembar properti yang disediakan penelepon yang terkait dengan struktur ini.

Untuk dokumentasi selengkapnya tentang struktur dan lembar properti ini secara umum, lihat Microsoft Windows SDK.

[in] PropertySheetHeaderPageListSize

Jumlah maksimum handel yang dapat ditahan oleh array pegangan lembar properti yang disediakan penelepon.

[out, optional] RequiredSize

Penunjuk ke variabel jenis DWORD yang menerima jumlah lembar properti yang terkait dengan elemen informasi perangkat yang ditentukan atau kelas penyiapan perangkat dari kumpulan informasi perangkat yang ditentukan. Penunjuk bersifat opsional dan dapat berupa NULL.

[in] PropertySheetType

Bendera yang menunjukkan salah satu jenis lembar properti berikut.

Jenis lembar properti	Makna
DIGCDP_FLAG_ADVANCED	Lembar properti tingkat lanjut.
DIGCDP_FLAG_BASIC	Lembar properti dasar. Hanya didukung di Microsoft Windows 95 dan Windows 98. Jangan gunakan di Windows 2000 dan versi Windows yang lebih baru.
DIGCDP_FLAG_REMOTE_ADVANCED	Lembar properti tingkat lanjut pada komputer jarak jauh.

Nilai kembali

Fungsi mengembalikan TRUE jika berhasil. Jika tidak, fungsi mengembalikan FALSE. Panggil GetLastError untuk mendapatkan kode kesalahan.

Keterangan

Struktur PROPERTYSHEETHEADER berisi dua anggota yang terkait dengan array yang disediakan pemanggil yang digunakan fungsi untuk mengembalikan handel lembar properti. Anggota phpages adalah penunjuk ke array handel lembar properti yang disediakan penelepon, dan nilai input anggota nPages menentukan jumlah handel yang sudah terkandung dalam array handel. Fungsi menambahkan handel lembar properti ke handle array yang dimulai dengan elemen array yang indeks array-nya adalah nilai input nPages. Fungsi menambahkan handel ke array dalam urutan berturut-turut hingga array penuh atau handel semua halaman lembar properti yang diminta telah ditambahkan ke array. Jumlah maksimum handel lembar properti yang dapat dikembalikan fungsi sama dengan (PropertySheetHeaderPageListSize - (nilai input nPages)).

Jika array handel cukup besar untuk menahan handel semua halaman lembar properti yang diminta, fungsi :

Menambahkan handel ke array handel.
Mengatur nPages ke jumlah total handel dalam array.
Mengatur RequiredSize ke jumlah handel yang dikembalikannya.
Mengembalikan TRUE.

Jika array handel tidak cukup besar untuk menahan handel semua halaman lembar properti yang ditentukan, fungsi :

Menambahkan handel sebanyak yang dapat ditahan array.
Mengatur nPages ke PropertySheetHeaderPageListSize.
Mengatur RequiredSize ke jumlah total halaman lembar properti yang diminta. Jumlah handel yang tidak dikembalikan oleh fungsi sama dengan (RequiredSize - PropertySheetHeaderPageListSize - (nilai input nPages)).
Mengatur kode kesalahan ke ERROR_INSUFFICIENT_BUFFER.
Mengembalikan FALSE.

Catatan

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

Persyaratan	Nilai
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

SP_DEVINFO_DATA

Bagikan melalui