Function Reference


_WinAPI_LoadImage

Loads an icon, cursor, or bitmap

#include <WinAPI.au3>
_WinAPI_LoadImage ( $hInstance, $sImage, $iType, $iXDesired, $iYDesired, $iLoad )

Parameters

$hInstance Identifies an instance of the module that contains the image to be loaded. To load an OEM
image, set this parameter to zero.
$sImage Identifies the image to load. If the $hInstance parameter is not 0 and the $iLoad parameter
does not include $LR_LOADFROMFILE $sImage is a string that contains the name of the image resource in the
$hInstance module. If $hInstance is 0 and $LR_LOADFROMFILE is not specified, the low-order word of this
parameter must be the identifier of the OEM image to load.
$iType Specifies the type of image to be loaded. This parameter can be one of the following values:
$IMAGE_BITMAP - Loads a bitmap
$IMAGE_CURSOR - Loads a cursor
$IMAGE_ICON - Loads an icon
$iXDesired Specifies the width, in pixels, of the icon or cursor. If this is 0
and $iLoad is $LR_DEFAULTSIZE the function uses the SM_CXICON or SM_CXCURSOR system
metric value to set the width. If this parameter is 0 and $LR_DEFAULTSIZE is not
used, the function uses the actual resource width.
$iYDesired Specifies the height, in pixels, of the icon or cursor. If this is 0
and $iLoad is $LR_DEFAULTSIZE the function uses the SM_CYICON or SM_CYCURSOR system
metric value to set the height. If this parameter is 0 and $LR_DEFAULTSIZE is not
used, the function uses the actual resource height.
$iLoad Specifies a combination of the following values:
$LR_DEFAULTCOLOR - The default flag
$LR_CREATEDIBSECTION - When the $iType parameter specifies $IMAGE_BITMAP, causes the function to return a DIB
section bitmap rather than a compatible bitmap. This flag is useful for loading a bitmap without mapping it
to the colors of the display device.
$LR_DEFAULTSIZE - Uses the width or height specified by the system metric values for cursors or icons if
the $iXDesired or $iYDesired values are set to 0. If this flag is not specified and $iXDesired and $iYDesired
are set to zero, the function uses the actual resource size. If the resource contains multiple images the
function uses the size of the first image.
$LR_LOADFROMFILE - Loads the image from the file specified by the $sImage parameter. If this flag is not
specified, $sImage is the name of the resource.
$LR_LOADMAP3DCOLORS - Searches the color table for the image and replaces the following shades of gray with
the corresponding 3D color:
Dk Gray: RGB(128,128,128) COLOR_3DSHADOW
Gray : RGB(192,192,192) COLOR_3DFACE
Lt Gray: RGB(223,223,223) COLOR_3DLIGHT
$LR_LOADTRANSPARENT - Gets the color value of the first pixel in the image and replaces the corresponding
entry in the color table with the default window color. All pixels in the image that use that entry become
the default window color. This value applies only to images that have corresponding color tables. If $iLoad
includes both the $LR_LOADTRANSPARENT and $LR_LOADMAP3DCOLORS values, $LRLOADTRANSPARENT takes precedence.
However, the color table entry is replaced with COLOR_3DFACE rather than COLOR_WINDOW.
$LR_MONOCHROME - Loads the image in black and white
$LR_SHARED - Shares the image handle if the image is loaded multiple times. If LR_SHARED is not set,
a second call to LoadImage for the same resource will load the image again and return a different handle. Do
not use $LR_SHARED for images that have non-standard sizes, that may change after loading, or that are loaded
from a file.

Return Value

Success: The handle of the newly loaded image
Failure: 0, call _WinAPI_GetLastError() to get extended error information

Remarks

Above constants require #include <WinAPIConstants.au3>

See Also

Search LoadImage in MSDN Library.