SetupDiGetClassDescriptionExA (setupapi.h)

  • Artikel

Fungsi SetupDiGetClassDescriptionEx mengambil deskripsi kelas penyiapan yang diinstal pada komputer lokal atau jarak jauh.

Sintaks

WINSETUPAPI BOOL SetupDiGetClassDescriptionExA(
  [in]            const GUID *ClassGuid,
  [out]           PSTR       ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCSTR      MachineName,
                  PVOID      Reserved
);

Parameter

[in] ClassGuid

Penunjuk ke GUID untuk kelas penyiapan yang deskripsinya akan diambil.

[out] ClassDescription

Penunjuk ke buffer karakter yang menerima deskripsi kelas.

[in] ClassDescriptionSize

Ukuran, dalam karakter, dari buffer yang diarahkan oleh parameter ClassDescription . Panjang maksimum, dalam karakter, dari deskripsi kelas yang dihentikan NULL adalah LINE_LEN. Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.

[out, optional] RequiredSize

Penunjuk ke variabel berjenis DWORD yang menerima ukuran, dalam karakter, yang diperlukan untuk menyimpan deskripsi kelas yang dihentikan NULL yang diminta. Penunjuk ini bersifat opsional dan dapat berupa NULL.

[in, optional] MachineName

Penunjuk ke string yang dihentikan NULL yang menyediakan nama komputer jarak jauh tempat kelas penyiapan berada. Penunjuk ini bersifat opsional dan dapat berupa NULL. Jika kelas diinstal pada komputer lokal, atur penunjuk ke NULL.

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

Dicadangkan untuk penggunaan sistem. Pemanggil fungsi ini harus mengatur parameter ini ke NULL.

Nilai kembali

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

Keterangan

Jika ada nama yang mudah diingat di kunci registri untuk kelas , rutinitas ini mengembalikan nama yang mudah diingat. Jika tidak, rutinitas ini mengembalikan nama kelas.

SetupDiGetClassDescriptionEx tidak memberlakukan pembatasan panjang deskripsi kelas yang dapat dikembalikan. Fungsi ini mengembalikan ukuran yang diperlukan untuk deskripsi kelas yang dihentikan NULL meskipun lebih besar dari LINE_LEN. Namun, LINE_LEN adalah panjang maksimum deskripsi kelas yang dihentikan NULL yang valid. Penelepon seharusnya tidak memerlukan buffer yang lebih besar dari LINE_LEN.

Catatan

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

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass