Функция SetupDiGetClassDescriptionA (setupapi.h)

Статья
11/20/2024

Функция setupDiGetClassDescription извлекает описание класса, связанное с указанным GUID класса установки.

Синтаксис

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

Параметры

[in] ClassGuid

GUID класса установки, описание которого требуется получить.

[out] ClassDescription

Указатель на буфер символов, который получает описание класса.

[in] ClassDescriptionSize

Размер в символах буфера класса .

[out, optional] RequiredSize

Указатель на переменную типа DWORD, получающую размер в символах, которая требуется для хранения описания класса (включая терминатор NULL). RequiredSize всегда меньше LINE_LEN. Этот параметр является необязательным и может быть null.

Возвращаемое значение

Функция возвращает TRUE, если она выполнена успешно. В противном случае возвращается FALSE, а ошибка журнала может быть получена с помощью вызова GetLastError.

Замечания

Вызовите SetupDiGetClassDescriptionEx, чтобы получить описание класса установки, установленного на удаленном компьютере.

Заметка

Заголовок setupapi.h определяет SetupDiGetClassDescription как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Microsoft Windows 2000 и более поздних версиях Windows.
целевая платформа	Настольный
заголовка	setupapi.h (include Setupapi.h)
библиотеки	Setupapi.lib

См. также

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass

Поделиться через