ImageList_LoadBitmap info  Overview  Group

The ImageList_LoadBitmap function creates an image list from the specified bitmap resource. ImageList_LoadBitmap is a macro that calls the ImageList_LoadImage function.

HIMAGELIST ImageList_LoadBitmap(

HINSTANCE hi,	// handle of instance containing the bitmap
LPCTSTR lpbmp,	// identifies the bitmap to load
int cx,	// image width
int cGrow,	// number of new images the list can contain
COLORREF crMask	// color used to generate a mask
);

Parameters

hi 

Handle to the instance that contains the bitmap resource. This parameter is NULL if you are loading an OEM bitmap.

lpbmp

Identifies the image to load.

If the hi parameter is non-NULL, lpszName is a pointer to a null-terminated string that contains the name of the image resource in the hi module.

If hi is NULL, the low-order word of this parameter must be the identifier of an OEM bitmap to load. To create this value, use the MAKEINTRESOURCE macro with one of the OEM bitmap identifiers defined in WINUSER.H. These identifiers have the OBM_ prefix.

cx

Width of each image. The height of each image and the initial number of images are inferred by the dimensions of the specified bitmap.

cGrow

Amount of images by which the image list can grow when the system needs to resize the list to make room for new images. This parameter represents the number of new images that the resized image list can contain.

crMask

Color used to generate a mask. Each pixel of this color in the specified bitmap is changed to black, and the corresponding bit in the mask is set to one. If this parameter is the CLR_NONE value, no mask is generated.

Return Values

If the function succeeds, the return value is the image list.

If the function fails, the return value is NULL.

See Also

ImageList_LoadImage