Метод IShellIconOverlayIdentifier::GetOverlayInfo (shobjidl_core.h)

Статья
08/26/2023

Предоставляет расположение растрового изображения наложения значка.

Синтаксис

HRESULT GetOverlayInfo(
  [out] LPWSTR pwszIconFile,
        int    cchMax,
  [out] int    *pIndex,
  [out] DWORD  *pdwFlags
);

Параметры

[out] pwszIconFile

Тип: PWSTR

Строка Юникода со значением NULL, содержащая полный путь к файлу со значком. Допустимы типы файлов .dll, .exe и ICO. Если вы возвращаете имя файла, необходимо задать флаг ISIOI_ICONFILE в pdwFlags .

cchMax

Тип: int

Размер буфера pwszIconFile в символах Юникода.

[out] pIndex

Тип: int*

Указатель на значение индекса, используемое для идентификации значка в файле, который содержит несколько значков. Если возвращается индекс, необходимо задать флаг ISIOI_ICONINDEX в pdwFlags .

[out] pdwFlags

Тип: DWORD*

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

ISIOI_ICONFILE (0x00000001)

Путь к файлу значка возвращается через pwszIconFile.

ISIOI_ICONINDEX (0x00000002)

В pwszIconFile есть несколько значков. Индекс значка возвращается через pIndex.

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

Тип: HRESULT

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

Этот метод вызывается оболочкой при запуске, чтобы наложение значка обработчика можно было добавить в список образов системы. После завершения инициализации оболочка вызывает Метод GetOverlayInfo , когда необходимо отобразить наложение значка обработчика.

Примечание После загрузки образа в список системных образов во время инициализации его нельзя изменить. После инициализации имя файла и индекс используются только для идентификации наложения значка. Система не будет загружать новое наложение значков. При вызове Метода GetOverlayInfo обработчик должен возвращать те же имя файла и индекс, которые были указаны при первом вызове функции.

Требования


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

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