<Image variable>.SaveBMP (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Prefix syntax

Drawing functions on Image variables

SaveBMP

Presentation

Example

See also

<Image variable>.SaveBMP (Function)

In french: <Variable Image>.SauveBMP

Saves an image:

in a BMP file.
in memory.

This image corresponds to the image contained in a Image control.

Remarks:

Only the visible part of the Image control is saved.
This function can only be used to save the images for screen resolutions up to 32 bits.
This function cannot be used with the Image controls found in the reports.

Example

// Saves in memory the image found in "IMG_ImageDrawing"
ResSave = IMG_ImageDrawing.SaveBMP(inMemory)

// Saves the image found in "IMG_ImageDrawing" in "C:\Documents\Image.BMP"
ResSave = IMG_ImageDrawing.SaveBMP("C:\Documents\Image.BMP")

Syntax

Saving an image in a file in BMP format Hide the details

<Result> = <Image variable>.SaveBMP(<File name> [, <Number of colors>])

<Result>: Boolean

True if the image was saved,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Image variable>: Image variable

Name of the Image control to be used.

<File name>: Character string

Name and full (or relative) path of BMP file to create. A UNC path can be used. The file extension is optional.
Caution:
The destination directory must exist in order for the image to be saved.
The existence of the BMP file is not checked. This file is automatically overwritten if it already exists.

<Number of colors>: Optional integer

Number of colors for the image saved:
0 (by default): number of colors defined in the screen resolution
16: 16 colors
This parameter corresponds to the number of colors proposed in the color palette when using the BMP file.

Saving an image in memory Hide the details

<Result> = <Image variable>.SaveBMP([<Number of colors>])

<Result>: Buffer

Byte string containing the image in BMP format. Then this byte string can be assigned to an Image control, saved in a file (fSaveText), sent via a network (with the Socket functions), ...

<Image variable>: Image variable

Name of the Image control to be used.

<Number of colors>: Optional integer

Number of colors for the image saved:
0 (by default): number of colors defined in the screen resolution.
16: 16 colors.
This parameter corresponds to the number of colors proposed in the color palette when using the BMP file.

Component: wd280pnt.dll