dSaveImageBMP (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Functions for handling graphic strings

Image found in a Web Camera control

Drawing in browser code

Drawing in PHP

See also

dSaveImageBMP (Function)

In french: dSauveImageBMP

Saves an image:

in a file in BMP format.
in memory.

This image corresponds to the image found:

in an Image control.
Versions 17 and later
in an Image variable.
New in version 17
in an Image variable.
in an Image variable. in an Image variable.
This type of variable is not available.
in a Bar Code control.
The Bar Code controls are not available in this version. Therefore, no image found in a Bar Code control can be saved.
in a Web Camera control.

Remarks:

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

Versions 15 and later

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The drawings for more details.

New in version 15

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The drawings for more details.

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The drawings for more details.

Versions 16 and later

This function is now available in Browser code.

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

New in version 16

This function is now available in Browser code.

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

This function is now available in Browser code.

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

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

// Saves in memory the image found in "IMG_ImageDrawing"
ResSave = dSaveImageBMP(IMG_ImageDrawing, inMemory)

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

// Saves the image found in "IMG_ImageDrawing" in "\Documents\Image.BMP"
ResSave = dSaveImageBMP(IMG_ImageDrawing, "\Documents\Image.BMP")

Syntax

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

<Result> = dSaveImageBMP(<Image name> , <File name> [, <Number of colors>])

<Result>: Boolean

True if the image was saved,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Image name>: Character string (with or without quotes) or Image variable

Name of Image control, Bar Code control or Web Camera control to use. The Image controls found in a report cannot be used.
Name of Image control or Web Camera control to use
Versions 17 and later
Name of the Image variable to use.
New in version 17
Name of the Image variable to use.
Name of the Image variable to use. Name of the Image variable to use.
This type of variable is not available.

<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.
Name and full path of BMP file to create. The file extension is optional.

<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.

Syntax not available

Saving an image in memory Hide the details

<Result> = dSaveImageBMP(<Image name> , <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 name>: Character string (with or without quotes) or Image variable

Name of Image control, Bar Code control or Web Camera control to use. The Image controls found in a report cannot be used.
Name of Image control or Web Camera control to use
Versions 17 and later
Name of the Image variable to use.
New in version 17
Name of the Image variable to use.
Name of the Image variable to use. Name of the Image variable to use.
This type of variable is not available.

<inMemory>: Constant

inMemory: Constant used to save an image in memory.

<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.

Remarks

Image found in a Web Camera control

Only the image displayed when dSaveImageBMP is run will be saved. To save this image, you can also use:

the function VideoCapture: the image will be saved in BMP format
the function dSaveImageGIF: the image will be saved in GIF format or in memory
the function dSaveImageJPEG: the image will be saved in JPEG format or in memory
the function dSaveImagePNG: the image will be saved in PNG format or in memory

Versions 16 and later

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), the images in BMP format are not displayed properly.

This operating mode may be improved during the next upgraded versions of this browser.

New in version 16

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), the images in BMP format are not displayed properly.

This operating mode may be improved during the next upgraded versions of this browser.

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), the images in BMP format are not displayed properly.

This operating mode may be improved during the next upgraded versions of this browser.

Drawing in PHP

In PHP, the drawing functions are based on the graphic library GD. This library is commonly used by the PHP hosting companies 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 : wd250pnt.dll