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

Статья
11/20/2024

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

Заметка

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

Синтаксис

HICON LoadIconA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpIconName
);

Параметры

[in, optional] hInstance

Тип: HINSTANCE

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

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

[in] lpIconName

Тип: LPCTSTR

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

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

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

Тип: HICON

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

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

Замечания

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

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h (включая Windows.h)
библиотеки	User32.lib
DLL	User32.dll
набор API	ext-ms-win-ntuser-gui-l1-1-0 (представлено в Windows 8)