dSaveImageJPEG (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions (Image controls and variables)

Functions for handling graphic strings

Image found in a Web Camera control

Drawing in browser code

Drawing in PHP

See also

dSaveImageJPEG (Function)

In french: dSauveImageJPEG

Saves an image:

in a file in JPEG 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.

Notes:

Only the visible part of 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.
This function can also be used to save the modifications performed by ImageInfoModify on the Exif tags of an image.
The backup of images in JPEG format is supported only if the application is run by the Java virtual machine (JVM) distributed by SUN. This backup does not operate with the other Java virtual machines.

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 for Android applications.

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 for Android applications.

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 for Android applications.

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 = dSaveImageJPEG(IMG_ImageDrawing, inMemory)

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

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

// Modify the comments of the image
// displayed in the "IMG_MyImageControl" control
ImageInfoModify(IMG_MyImageControl, imgComment, "Coral Reef")
// Save the modification in the
// "C:\Diving\Coral.JPG" file
dSaveImageJPEG(IMG_MyImageControl, "C:\Dives\Gorgone1.JPG", 100, imgSaveTag)

Syntax

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

<Result> = dSaveImageJPEG(<Image name> , <File name> [, <Quality> [, <Exif tag>]])

<Result>: Boolean

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

<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
Name of Image 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 (with quotes)

Name and full (or relative) path of JPEG file. 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 JPEG file is not checked. This file is automatically overwritten if it already exists.
Name and full path of JPEG file to create. The file extension is optional.

<Quality>: Optional integer

Quality of the image saved. Value included between 1 and 100 (80 by default). The lower the image quality will be, the higher the compression rate of the image will be and the smaller the file size will be.

<Exif tag>: Optional constant (or combination of constants)

Saves the Exif tags modified by ImageInfoModify:
imgAddThumbnail Adds a thumbnail into the image file (<File name>).
This constant is ignored if a thumbnail is found in the image file displayed in the Image control.
This constant is not available.
imgProgressiveJPEG Used to save the image in progressive JPEG format. This format is mainly used for the Web sites. It allows the pages to be loaded faster (the images being loaded and displayed progressively).
imgGrayScale Used to save the image in black and white ("Grayscale" display mode).
imgSaveTag Saves the Exif tags.
A new thumbnail is calculated if a thumbnail is found in the image file displayed in the Image control.
This constant is not available.
By default, the Exif tags are not saved, no operation is performed on the thumbnails.
This parameter is available only if <Control name> corresponds to the name of an Image control.
This parameter is not available.

Syntax not available

Saving an image in memory Hide the details

<Result> = dSaveImageJPEG(<Image name> , <inMemory> [, <Quality> [, <Exif tag>]])

<Result>: Buffer

Byte string containing the image in JPEG 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
Name of Image 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.

<Quality>: Optional integer

Quality of the image saved. Value included between 1 and 100 (80 by default). The lower the image quality will be, the higher the compression rate of the image will be and the smaller the file size will be.

<Exif tag>: Optional constant (or combination of constants)

Save the Exif tags modified by ImageInfoModify:
imgAddThumbnail Adds a thumbnail into the image file (<File name>).
This constant is ignored if a thumbnail is found in the image file displayed in the Image control.
This constant is not available.
imgProgressiveJPEG Used to save the image in progressive JPEG format. This format is mainly used for the Web sites. It allows the pages to be loaded faster (the images being loaded and displayed progressively).
imgSaveTag Saves the Exif tags.
A new thumbnail is calculated if a thumbnail is found in the image file displayed in the Image control.
This constant is not available.
By default, the Exif tags are not saved, no operation is performed on the thumbnails.
This parameter is available only if <Control name> corresponds to the name of an Image control.
This parameter is not available.

Remarks

Image found in a Web Camera control

Only the image displayed when dSaveImageJPEG 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 dSaveImageBMP: the image will be saved in BMP format or in memory
the function dSaveImageGIF: the image will be saved in GIF 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 JPEG with the current version of FireFox and Opera (available when this documentation was published), the images in GIF format are not displayed properly (they are displayed on a black background).

This operating mode may be improved during the next upgraded versions of these browsers.

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.

This operating mode may be improved during the next upgraded versions of these browsers.

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.

This operating mode may be improved during the next upgraded versions of these browsers.

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 : wd240pnt.dll