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


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

Функция 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

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

[out, optional] RequiredSize

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

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

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

Комментарии

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

Примечание

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

Требования

   
Минимальная версия клиента Доступно в Microsoft Windows 2000 и более поздних версиях Windows.
Целевая платформа Персональный компьютер
Верхняя часть setupapi.h (включая Setupapi.h)
Библиотека Setupapi.lib

См. также раздел

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass