<Image>.SaveBMP (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Drawing functions

Image found in a Web Camera control
Drawing in browser code
Drawing in PHP

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Image>.SaveBMP (Function)

In french: <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 reports.

Caution: Using this function under Linux requires a specific configuration.. For more details, see The drawings.

In browser code, this function can only be used to save an image in memory.

Example

// Sauve en mémoire l'image présente dans "IMG_ImageDessin"
ResSauvegarde = IMG_ImageDessin.SauveBMP(inMemory)

// Sauve l'image présente dans "IMG_ImageDessin" sur "C:\Documents\Image.BMP"
ResSauvegarde = IMG_ImageDessin.SauveBMP("C:\Documents\Image.BMP")

Syntax

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

<Result> = <Image control>.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 control>: Control name

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 (default): number of colors defined in 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 control>.SaveBMP(<inMemory> [, <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), ...
In browser code, this byte string can only be assigned to another image ("Localize the image in the _WEB directory in browser code" must be unchecked). It cannot be saved in a file to build an image file.

<Image control>: Control name

Name of the Image control to be used.

<inMemory>: Constant

inMemory: Constant used to save an image in memory.

<Number of colors>: Optional integer

Number of colors for the image saved:
0 (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.

Remarks

Image found in a Web Camera control

Only the image displayed when <Image>.SaveBMP is executed is saved. To save this image, you can also use:

the <Camera>.Capture function: the image will be saved in BMP format
the <Image>.SaveGIF function: the image will be saved either in Gif format or in memory.
the <Image>.SaveJPEG function: the image will be saved either in Jpeg format or in memory.
the <Image>.SavePNG function: the image will be saved either in PNG format or in memory

Drawing in browser code

The image saved in memory can be directly assigned to an Image control. Depending on the browser used, the result may not be the expected one.

For example, with the current version of FireFox (available when this documentation was published), images in BMP format are not displayed properly.

This may be fixed in future browser updates.

Drawing in PHP

In PHP, the drawing functions are based on the graphic library GD. This library is commonly used by the PHP hosting providers and therefore it is always enabled. The version of the GD library must be version 2.0.28 (or later). This library can be downloaded from the PHP site.

To enable (if necessary) this library locally, the following elements are required:

PHP installed.
the PHP.INI file found in the Windows directory must contain the following line: "extension=php_gd2.dll" (instead of ";extension=php_gd2.dll").
the php_gd2.dll file must exist in the directory of PHP extensions. This directory is defined in the PHP.INI file by the "extension_dir" variable.

Component: wd300pnt.dll