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.
4/8/2010

Converts an image file in the resource file to a bitmap file. A resource image file should be coded in the resource file as follows (using BMP as an example): IDB_MYIMAGE_BMP GIF DISCARDABLE "MyImage.bmp".

Note:
Please note that the example resource line above correctly specifies GIF, even though the resource itself is actually a bitmap. GIF should be specified for all image resources, regardless of their format. Supplying any specifier other than GIF results in failure to load the image resource.

Syntax 

HBITMAP SHLoadImageResource (
  HINSTANCE 
hinst,
  UINT 
uIdImageFile
);

Parameters

hinst

[in] Handle to the module whose executable file contains the image file.

uIdImageFile

[in] UINT identifying the image file.

Return Value

A handle to a bitmap if successful, NULL otherwise.

Remarks

This function converts files of several types, including GIF (Graphics Interchange Format), PNG (Portable Network Graphics), JPG (Joint Photographic Experts Group), ICO (icon), and BMP (bitmap) file formats.

Note:
When you no longer need the SHLoadImageResource Object call the DeleteObjectfunction to delete it.

Requirements

Header aygshell.h
Library aygshell.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Pocket PC for Windows Mobile 2003 and later

See Also

Reference

Shell Functions