PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

  • Document coming from the Twain device
  • Managing the type of image
  • Duplex scanner
  • Multi-page scanner with loader
  • Operating mode in the 64-bit applications
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Used to:
  • save the document coming from the Twain device in a JPEG file.
  • view the document coming from the Twain device in the user interface of device. The user will have the ability to perform one of the actions proposed by this interface (for example: save the document, modify the default parameters of the device). The available actions depend on the device used.
Example
// Saves the document found in the scanner in the "MyPhoto.JPEG" file
// The document will be saved in black and white
IF TwainToBMP("C:\Temp\MyPhoto.BMP", False, TwainBlackWhite) = True THEN
Info("The document was saved")
ELSE
Error("The document was not scanned")
END
Syntax
<Result> = TwainToJPEG([<JPEG file> [, <Image Quality> [, <User Interface> [, <Type of Image> [, <Number of Bits per Pixel> [, <Image Resolution> [, <Image Contrast> [, <Image Brightness> [, <Duplex Mode> [, <Automatic Load>]]]]]]]]]])
<Result>: Boolean
  • True if the document was saved or viewed,
  • False if the document was neither saved nor viewed.
<JPEG file>: Optional character string
Name and full (or relative) path of file (up to 260 characters). The file extension is optional. A UNC path can be used.
If this parameter is not specified or if it corresponds to an empty string (""), the user will have to enter the full name of the JPEG file in a file picker.
<Image Quality>: Optional integer
Quality of the document image (value included between 1 and 100). 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.
The default image quality will be used:
  • if this parameter is not specified or if it corresponds to 0.
  • if the specified quality is not supported by the device.
  • if <User Interface> is set to True.
<User Interface>: Optional boolean
  • True (default value) if the user interface of the Twain device must be displayed. When saving the document, the <BMP file> will be proposed by default.
  • False if the user interface of the Twain device must not be displayed.
<Type of Image>: Optional Integer constant (or combination of constants)
Type of image used to save the document (classified by order of color management):
Order for managing the colors
0 (Default value)Default image of device.
1TwainPaletteImage whose colors are issued from a palette.
2TwainRGBRGB image.
3TwainGrayScaleImage in grayscale.
4TwainBlackWhiteImage in black and white.
-TwainAnyTypeAny type of image.
If these constants are combined, the best type of image supported by the device will be selected (according to the order of color management). See remarks for more details.
The default type of image will be used:
  • if this parameter is not specified or if it corresponds to 0.
  • if the specified type of image is not supported by the device.
  • if <User Interface> is set to True.
<Number of Bits per Pixel>: Optional integer
Amount of information about the colors (to display or print each pixel in an image). The larger the number of bits per pixel, the sharper the color rendering will be.
The possible values for this parameter depend on the type of image used:
Type of imagePossible values
Image whose colors are issued from a palette (TwainPalette constant)1, 4 or 8
RGB image (TwainRGB constant)8, 10 or 16
Image in grayscale (TwainGrayScale constant)8 or 16
Image in black and white (TwainBlackWhite constant)1
If this parameter is not specified, the default number of bits per pixel will be used.
<Image Resolution>: Optional real
Number of pixels per inch (the possible values depend on the device used).
The default image resolution will be used:
  • if this parameter is not specified or if it corresponds to 0.
  • if the specified resolution is not supported by the device.
  • if <User Interface> is set to True.
<Image Contrast>: Optional real
Contrast of the image (value included between -1000 and 1000).
The default image contrast will be used:
  • if this parameter is not specified or if it corresponds to 0.
  • if the specified contrast is not supported by the device.
  • if <User Interface> is set to True.
<Image Brightness>: Optional real
Brightness of the image (value included between -1000 and 1000).
The default image brightness will be used:
  • if this parameter is not specified or if it corresponds to 0.
  • if the specified brightness is not supported by the device.
  • if <User Interface> is set to True.
<Duplex Mode>: Optional boolean
  • True to scan a document on both sides,
  • False (by default) to scan the document on a single side.
<Automatic Load>: Optional boolean
Versions 15 and later
True to automatically load the pages in the device.
New in version 15
True to automatically load the pages in the device.
True to automatically load the pages in the device.
Remarks

Document coming from the Twain device

The "document coming from the Twain device" corresponds to:
  • the document found in a scanner during the call to TwainToJPEG. In this case, the parameters specified in TwainScanZone are taken into account.
  • the image broadcasted by a "web camera" during the call to TwainToJPEG.
  • the first photo saved in a digital camera.
    Note: If the user interface is used, the retrieved document will correspond to the photo selected by the user. If several photos are selected, only the first selected photo will be retrieved.

Managing the type of image

If several constants are combined in <Type of Image>, the best type of image supported by the device will be selected (according to the order of color management).
For example: If this parameter corresponds to TwainBlackWhite + TwainRGB, the type of the image will be:
  • RGB if this type is supported by the device.
  • black and white otherwise.

Duplex scanner

If the scanner supports the duplex mode, you have the ability to perform a double-sided scan. The generated document contains both sides of the scanned document.
Note: Depending on the hardware used, the Twain driver may not be sufficient to support a double-sided scan. You may have to install additional drivers supplied by the manufacturer.

Multi-page scanner with loader

If the scanner includes a loader and if it supports the multi-pages, you have the ability to perform a scan of all the pages in a row.
See TwainState for more details.

Operating mode in the 64-bit applications

In a 64-bit application, this function will automatically use the 64-bit Twain driver. The TWAIN cannot be used if this driver is not installed.
Components
WINDEVReports and Queries wd230std.dll
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment