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

Статья
11/20/2024

[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 или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

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