Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This macro calls the ImageList_LoadImagefunction to create an image list from the specified bitmap resource.

Syntax 

HIMAGELIST WINAPI ImageList_LoadBitmap(
  HINSTANCE 
hi, 
  LPCSTR 
lpbmp, 
  int 
cx, 
  int 
cGrow, 
  COLORREF 
crMask 
);

Parameters

hi

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

lpbmp

[in] Long pointer to the image to load.

If the hiparameter is non-NULL, lpbmpis the address of a null-terminated string that contains the name of the image resource in the himodule.

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

cx

[in] 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

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

crMask

[in] 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 1. If this parameter is the CLR_NONE value, no mask is generated.

Return Value

The handle to the image list indicates success. NULL indicates failure.

Remarks

This macro is not supported for emulation.

Requirements

Header commctrl.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also