Функция LoadIconW (winuser.h)

Статья
03/13/2024

Загружает указанный ресурс значка из исполняемого файла (.exe), связанного с экземпляром приложения.

Примечание

Эта функция заменена функцией LoadImage (с установленными флагами LR_DEFAULTSIZE и LR_SHARED ).

Синтаксис

HICON LoadIconW(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCWSTR   lpIconName
);

Параметры

[in, optional] hInstance

Тип: HINSTANCE

Дескриптор модуля dll или исполняемого файла (.exe), содержащего загружаемый значок. Дополнительные сведения см. в разделе GetModuleHandle.

Чтобы загрузить предопределенный системный значок, задайте для этого параметра значение NULL.

[in] lpIconName

Тип: LPCTSTR

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

Если hInstance имеет значение NULL, lpIconName указывает идентификатор (начиная с префикса IDI_) предопределенного системного значка для загрузки.

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

Тип: HICON

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

Если функция завершается сбоем, возвращается значение NULL. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

LoadIcon загружает ресурс значка только в том случае, если он не был загружен; В противном случае он получает дескриптор существующего ресурса. Функция ищет в ресурсе значка значок, наиболее подходящий для текущего отображения. Ресурс значка может быть цветным или монохромным растровым изображением.

LoadIcon может загружать только значок, размер которого соответствует SM_CXICON и SM_CYICON системным значениям метрик. Используйте функцию LoadImage для загрузки значков других размеров.

Примечание

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

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winuser.h (включая Windows.h)
Библиотека	User32.lib
DLL	User32.dll
Набор API	ext-ms-win-ntuser-gui-l1-1-0 (представлено в Windows 8)