Fungsi SetupDiGetClassDescriptionW (setupapi.h)

Fungsi SetupDiGetClassDescription mengambil deskripsi kelas yang terkait dengan GUID kelas penyiapan yang ditentukan.

Sintaksis

WINSETUPAPI BOOL SetupDiGetClassDescriptionW(
  [in]            const GUID *ClassGuid,
  [out]           PWSTR      ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize
);

Parameter

[in] ClassGuid

GUID kelas penyiapan yang deskripsinya akan diambil.

[out] ClassDescription

Penunjuk ke buffer karakter yang menerima deskripsi kelas.

[in] ClassDescriptionSize

Ukurannya, dalam karakter, dari buffer ClassDescription .

[out, optional] RequiredSize

Pointer ke variabel jenis DWORD yang menerima ukuran, dalam karakter, yang diperlukan untuk menyimpan deskripsi kelas (termasuk terminator NULL). RequiredSize selalu kurang dari LINE_LEN. Parameter ini bersifat opsional dan dapat NULL.

Mengembalikan nilai

Fungsi mengembalikan TRUE jika berhasil. Jika tidak, ini mengembalikan FALSE dan kesalahan yang dicatat dapat diambil dengan panggilan ke GetLastError.

Komentar

Panggil SetupDiGetClassDescriptionEx untuk mengambil deskripsi kelas penyiapan yang diinstal pada komputer jarak jauh.

Nota

Header setupapi.h mendefinisikan SetupDiGetClassDescription sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praproscesor 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	Tersedia di Microsoft Windows 2000 dan versi Windows yang lebih baru.
Platform Target	Desktop
Header	setupapi.h (termasuk Setupapi.h)
Pustaka	Setupapi.lib
set API	ext-ms-win-setupapi-classinstallers-l1-1-2 (diperkenalkan di Windows 10, versi 10.0.14393)

Lihat juga

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass