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

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

  • Статья

Функция SetupDiGetClassDescriptionEx извлекает описание класса установки, установленного на локальном или удаленном компьютере.

Синтаксис

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

Параметры

[in] ClassGuid

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

[out] ClassDescription

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

[in] ClassDescriptionSize

Размер (в символах) буфера, на который указывает параметр ClassDescription . Максимальная длина (в символах) описания класса, заканчивающегося значением NULL, равна LINE_LEN. Дополнительные сведения см. в следующем разделе Примечания .

[out, optional] RequiredSize

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

[in, optional] MachineName

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

Внимание!

Использование этой функции для доступа к удаленным компьютерам не поддерживается, начиная с Windows 8 и Windows Server 2012, так как эта функция была удалена.

Reserved

Зарезервировано для системного использования. Вызывающий объект этой функции должен присвоить этому параметру значение NULL.

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

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

Комментарии

Если в разделе реестра для класса есть понятное имя, эта подпрограмма возвращает понятное имя. В противном случае эта подпрограмма возвращает имя класса.

SetupDiGetClassDescriptionEx не применяет ограничение на длину возвращаемого описания класса. Эта функция возвращает необходимый размер для описания класса, завершаемого значением NULL, даже если оно больше LINE_LEN. Однако LINE_LEN является максимальной длиной допустимого описания класса, завершаемого значением NULL. Вызывающий объект никогда не должен нуждаться в буфере, превышающем LINE_LEN.

Примечание

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

Требования

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

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

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass