Функция SHGetStockIconInfo (shellapi.h)

Статья
08/26/2023

Извлекает сведения о системных значках оболочки.

Синтаксис

SHSTDAPI SHGetStockIconInfo(
            SHSTOCKICONID   siid,
            UINT            uFlags,
  [in, out] SHSTOCKICONINFO *psii
);

Параметры

siid

Тип: SHSTOCKICONID

Одно из значений перечисления SHSTOCKICONID , указывающее, какой значок следует извлечь.

uFlags

Тип: UINT

Сочетание нулевых или более следующих флагов, указывающих, какие сведения запрашивается.

SHGSI_ICONLOCATION

Члены szPath и iIcon структуры SHSTOCKICONINFO получают путь и индекс значка запрошенного значка в формате, подходящем для передачи в функцию ExtractIcon . Числовое значение этого флага равно нулю, поэтому вы всегда получаете расположение значка независимо от других флагов.

SHGSI_ICON

Элемент hIcon структуры SHSTOCKICONINFO получает дескриптор указанного значка.

SHGSI_SYSICONINDEX

Элемент iSysImageImage структуры SHSTOCKICONINFO получает индекс указанного значка в списке образов системы.

SHGSI_LINKOVERLAY

Изменяет значение SHGSI_ICON, заставляя функцию добавлять наложение ссылки на значок файла.

SHGSI_SELECTED

Изменяет значение SHGSI_ICON, заставляя функцию смешивать значок с цветом выделения системы.

SHGSI_LARGEICON

Изменяет значение SHGSI_ICON, заставляя функцию получать большую версию значка, как указано в SM_CXICON и SM_CYICON системных метрик.

SHGSI_SMALLICON

Изменяет значение SHGSI_ICON, заставляя функцию получать небольшую версию значка, как указано в SM_CXSMICON и SM_CYSMICON системных метрик.

SHGSI_SHELLICONSIZE

Изменяет значения SHGSI_LARGEICON или SHGSI_SMALLICON, заставляя функцию получать значки размера оболочки, а не размеры, заданные системными метриками.

[in, out] psii

Тип: SHSTOCKICONINFO*

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

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

Тип: HRESULT

Если эта функция завершается успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Если эта функция возвращает дескриптор значка в элементе hIcon структуры SHSTOCKICONINFO , на которую указывает psii, вы несете ответственность за освобождение значка с помощью DestroyIcon , когда он вам больше не нужен.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	shellapi.h
DLL	Shell32.dll
Набор API	ext-ms-win-shell-shell32-l1-2-1 (представлено в Windows 10 версии 10.0.10240)

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