Функция SHGetIconOverlayIndexW (shlobj_core.h)

Статья
03/15/2023

Возвращает индекс значка наложения в списке системных образов.

Синтаксис

int SHGetIconOverlayIndexW(
  [in, optional] LPCWSTR pszIconPath,
                 int     iIconIndex
);

Параметры

[in, optional] pszIconPath

Тип: LPCTSTR

Указатель на строку, завершающуюся нулевым значением, с максимальной длиной MAX_PATH, содержащую полный путь к файлу со значком.

iIconIndex

Тип: int

Индекс значка в файле, на который указывает pszIconPath. Чтобы запросить стандартный значок наложения, задайте для pszIconPathзначение NULL, а для iIconIndex — одно из следующих значений:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

Значок наложения, указывающий общую папку.

IDO_SHGIOI_LINK (0x0FFFFFFE)

Значок наложения, указывающий на связанную папку или файл.

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

Значок наложения, указывающий на медленный файл.

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 и более поздние версии. Значок наложения, указывающий, что элемент является элементом по умолчанию в наборе. Одним из примеров является принтер по умолчанию.

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

Тип: int

Возвращает индекс значка наложения в списке системных образов в случае успешного выполнения или значение -1 в противном случае.

Наложения значков являются частью списка образов системы. У них есть два идентификатора. Первый — это одноуровневый индекс наложения, который определяет наложение относительно других наложений в списке изображений. Другой — индекс изображения, который идентифицирует фактическое изображение. Эти два индекса эквивалентны значениям, присвоенным параметрам iOverlay и iImage , соответственно, при добавлении наложения значков в список частных изображений с ImageList_SetOverlayImage. SHGetIconOverlayIndex возвращает индекс наложения. Чтобы преобразовать индекс наложения в эквивалентный индекс изображения, вызовите INDEXTOOVERLAYMASK.

Примечание После загрузки образа в список системных образов во время инициализации его нельзя изменить. Имя файла и индекс, заданные pszIconPath и iIconIndex , используются только для определения наложения значка. SHGetIconOverlayIndex нельзя использовать для изменения списка образов системы.

Примечание

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

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shlobj_core.h (включая Shlobj.h, Shlobj_core.h)
Библиотека	Shell32.lib
DLL	Shell32.dll (версия 5.0 или более поздняя)

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

IShellIconOverlay

IShellIconOverlayIdentifier

Share via