LoadImage (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Numbered drawings
Limits

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

LoadImage (Function)

In french: ChargeImage

Loads an image in memory so that it can be used later by gImage.

Example

// The "C:\MyImages\Image.BMP" image includes
// 20 drawings organized in 10 rows and 2 columns.
// No border will be displayed around them.
LoadImage(ImageID, "C:\MyImages\Image.BMP", 10, 2, "C")

// The "\MyImages\Image.BMP" image includes
// 20 drawings organized in 10 rows and 2 columns.
// No border will be displayed around them.
LoadImage(ImageID, "\MyImages\Image.BMP", 10, 2, "C")

Syntax

<Result> = LoadImage(<Image identifier> , <Image name> [, <Number of rows> [, <Number of columns> [, <Border>]]])

<Result>: Boolean

True if the image was loaded in memory,
False otherwise.

<Image identifier>: Integer

Identifier of image loaded in memory (included between 1 and 9). If this identifier is already used, the loaded image replaces the previous image. This identifier will be used by gImage.

<Image name>: Character string

Name and full (or relative) path of image to load. A UNC path can be used.
No relative path or UNC path can be used.

<Number of rows>: Optional integer

Number of drawings rows found in the image (up to 255 rows).

<Number of columns>: Optional integer

Number of drawings columns found in the image (up to 255 columns).

<Border>: Optional character

"C" if no border must be displayed around each drawing. By default, a 1-pixel border is displayed around each drawing.

Remarks

Numbered drawings

An image can contain several drawings organized in rows and columns. All these drawings must have the same size and they can be enclosed in a 1-pixel border.

Drawings are numbered from 1 to <Number of rows> * <Number of columns> from left to right and from top to bottom.

When adding a drawing into the image, the call to LoadImage must be modified in order to specify the new number of drawings in width and in height.

Remarks:

Versions 15 and later
LoadImageSheet simplifies the additions of drawings into the image. We recommend that you use this function.
New in version 15
LoadImageSheet simplifies the additions of drawings into the image. We recommend that you use this function.
LoadImageSheet simplifies the additions of drawings into the image. We recommend that you use this function.
Versions 21 and later
gImageExists is used to find out whether an image was loaded in memory by LoadImage or LoadImageSheet.
New in version 21
gImageExists is used to find out whether an image was loaded in memory by LoadImage or LoadImageSheet.
gImageExists is used to find out whether an image was loaded in memory by LoadImage or LoadImageSheet.

Limits

LoadImage must not be used in the code of the project. Indeed, this function must be used in the window where the image must be handled.

Component : wd260obj.dll