Метод IShellIconOverlay::GetOverlayIconIndex (shlobj_core.h)

  • Статья

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

Синтаксис

HRESULT GetOverlayIconIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIconIndex
);

Параметры

[in] pidl

Тип: PCUITEMID_CHILD

Указатель на структуру ITEMIDLIST , которая идентифицирует объект, значок которого отображается.

[in, out] pIconIndex

Тип: int*

Указатель на индекс изображения наложения значка в списке системных образов. Этот индекс эквивалентен значению iImage , указанному при добавлении изображения наложения в частный список изображений с помощью функции ImageList::SetOverlayImage .

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

Тип: HRESULT

Этот метод может возвращать одно из этих значений.

Код возврата Описание
S_OK
 Найден индекс наложения.
S_FALSE
 Наложение для этого файла не существует.
E_FAIL
 Недопустимый идентификатор PIDL.

Комментарии

Чтобы получить индекс изображения наложения в списке системных образов, необходимо сначала вызвать SHGetIconOverlayIndex , чтобы получить индекс наложения. Затем используйте макрос INDEXTOOVERLAYMASK для преобразования индекса наложения в эквивалентный индекс изображения.

Требования

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

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

IShellIconOverlay