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

Статья
11/20/2024

Функция setupDiGetClassImageListEx создает список растровых изображений для каждого класса, установленного в локальной или удаленной системе.

Синтаксис

WINSETUPAPI BOOL SetupDiGetClassImageListExA(
  [out]          PSP_CLASSIMAGELIST_DATA ClassImageListData,
  [in, optional] PCSTR                   MachineName,
                 PVOID                   Reserved
);

Параметры

[out] ClassImageListData

Указатель на структуру SP_CLASSIMAGELIST_DATA для получения сведений о списке изображений класса, включая дескриптор списка изображений. Поле cbSize этой структуры необходимо инициализировать с размером структуры в байтах перед вызовом этой функции или сбоем.

[in, optional] MachineName

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

Осторожность

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

Reserved

Должен быть null.

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

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

Замечания

Список изображений, созданный этой функцией, должен быть уничтожен путем вызова SetupDiDeskClassImageList.

Заметка значки для определенных классов на удаленном компьютере могут отображаться только в том случае, если класс также присутствует на локальном компьютере. Таким образом, если удаленный компьютер имеет класс X, но класс X не установлен локально, будет возвращен универсальный (неизвестный) значок.

Заметка

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

Требования

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

См. также

SetupDiDeskClassImageList

SetupDiGetClassImageList

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