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

Статья
11/20/2024

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

Синтаксис

int SHGetIconOverlayIndexA(
  [in, optional] LPCSTR pszIconPath,
                 int    iIconIndex
);

Параметры

[in, optional] pszIconPath

Тип: LPCTSTR

Указатель на строку, завершающуюся значением NULL, максимальную длину 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 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	shlobj_core.h (include Shlobj.h, Shlobj_core.h)
библиотеки	Shell32.lib
DLL	Shell32.dll (версия 5.0 или более поздняя версия)

См. также

IShellIconOverlay

IShellIconOverlayIdentifier

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