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

Статья
11/20/2024

Функция 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 или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

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

См. также

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass

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