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

Статья
08/27/2023

[LoadBitmap доступен для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. Вместо этого используйте LoadImage и DrawFrameControl.]

Функция LoadBitmap загружает указанный ресурс растрового изображения из исполняемого файла модуля.

Синтаксис

HBITMAP LoadBitmapA(
  [in] HINSTANCE hInstance,
  [in] LPCSTR    lpBitmapName
);

Параметры

[in] hInstance

Дескриптор экземпляра модуля, исполняемый файл которого содержит загружаемое растровое изображение.

[in] lpBitmapName

Указатель на строку, завершающуюся значением NULL, которая содержит имя загружаемого ресурса растрового изображения. Кроме того, этот параметр может состоять из идентификатора ресурса в слове низкого порядка и нуля в слове высокого порядка. Для создания этого значения можно использовать макрос MAKEINTRESOURCE .

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

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

Если функция завершается сбоем, возвращается значение NULL.

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

LoadBitmap создает совместимое растровое изображение дисплея, которое не может быть выбрано для принтера. Чтобы загрузить точечный рисунок, который можно выбрать на принтер, вызовите LoadImage и укажите LR_CREATEDIBSECTION для создания раздела DIB. Раздел DIB можно выбрать для любого устройства.

Приложение может использовать функцию LoadBitmap для доступа к предопределенным растровым изображениям. Для этого приложение должно задать для параметра hInstanceзначение NULL , а для параметра lpBitmapName — одно из следующих значений.

Имя растрового рисунка	Имя растрового рисунка
OBM_BTNCORNERS	OBM_OLD_RESTORE
OBM_BTSIZE	OBM_OLD_RGARROW
OBM_CHECK	OBM_OLD_UPARROW
OBM_CHECKBOXES	OBM_OLD_ZOOM
OBM_CLOSE	OBM_REDUCE
OBM_COMBO	OBM_REDUCED
OBM_DNARROW	OBM_RESTORE
OBM_DNARROWD	OBM_RESTORED
OBM_DNARROWI	OBM_RGARROW
OBM_LFARROW	OBM_RGARROWD
OBM_LFARROWD	OBM_RGARROWI
OBM_LFARROWI	OBM_SIZE
OBM_MNARROW	OBM_UPARROW
OBM_OLD_CLOSE	OBM_UPARROWD
OBM_OLD_DNARROW	OBM_UPARROWI
OBM_OLD_LFARROW	OBM_ZOOM
OBM_OLD_REDUCE	OBM_ZOOMD

Имена растровых рисунков, начинающиеся с OBM_OLD представляют растровые изображения, используемые в 16-разрядных версиях Windows, предшествующих версии 3.0.

Чтобы приложение использовало любую из констант OBM_, константа OEMRESOURCE должна быть определена перед включением файла заголовка Windows.h.

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

Примеры

Пример см. в разделе Пример Menu-Item растровых изображений в разделе Использование меню.

Примечание

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

Требования

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