| HBITMAP LoadBitmap(hinst, lpszBitmap) | |||||
| HANDLE hinst; | /* handle of application instance | */ | |||
| LPCTSTR lpszBitmap; | /* address of bitmap-resource name | */ | |||
The LoadBitmap function loads the specified bitmap resource from the given module's executable file.
hinst
Identifies the instance of the module whose executable file contains the bitmap to be loaded.
lpszBitmap
Points to a null-terminated string that contains the name of the bitmap resource to be loaded. Alternatively, this parameter can consist of the resource identifier in the low-order word and zero in the high-order word. The MAKEINTRESOURCE macro can be used to create this value.
The return value is the handle of the specified bitmap if the function is successful. Otherwise, it is NULL.
If the bitmap pointed to by lpszBitmap does not exist or if there is insufficient memory to load the bitmap, the function fails.
The application must call the DeleteObject function to delete each bitmap handle returned by the LoadBitmap function. This also applies to the following predefined bitmaps.
An application can use the LoadBitmap function to access the predefined bitmaps used by Windows. To do so, the application must set the hinst parameter to NULL and the lpszBitmap parameter to one of the following values:
| 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 |
Bitmap names that begin with OBM_OLD represent bitmaps used by Windows versions earlier than 3.0.
Note that for an application to use any of the OBM_ constants, the constant OEMRESOURCE must be defined before the WINDOWS.H header file is included.
The LoadBitmap function may be used as either a wide-character function (where text arguments must use Unicode) or an ANSI function (where text arguments must use characters from the Windows 3.x character set installed).
DeleteObject, LoadIcon, LoadCursor, CreateBitmap