TwainToClipboard (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

WEBDEV

WINDEV Mobile

Others

See also

TwainToClipboard (Function)

In french: TwainVersPressePapier

Used to:

copy the document coming from the Twain device into the clipboard.
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.
When validating the user interface, the document coming from the Twain device will be copied into the clipboard. The parameters specified in the user interface will be taken into account.

Example

// Copies the 1st photograph saved in the digital camera
// into the clipboard
// The photo will be saved in black and white
IF TwainToClipboard(False, TwainBlackWhite) = True THEN
Info("The photo was copied to the clipboard")
ELSE
Error("The photo was not copied")
END

Syntax

<Result> = TwainToClipboard([<User interface> [, <Type of image> [, <Number of bits per pixel> [, <Image resolution> [, <Image contrast> [, <Image brightness> [, <Duplex mode>]]]]]]])

<Result>: Boolean

True if the document was copied into the clipboard,
False otherwise. The corresponding error message is returned by ErrorInfo.

<User interface>: Optional boolean

True (default value) if the user interface of the Twain device must be displayed,
False otherwise.

<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
1 TwainPalette Colored image issued from a palette.
2 TwainRGB RGB image.
3 TwainGrayScale Grayscale image.
4 TwainBlackWhite Image in black and white.
- TwainAnyType Any 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 image Possible values
Colored image issued from a palette (TwainPalette constant) 1, 4 or 8
RGB image (TwainRGB constant) 8, 10 or 16
Grayscale image (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.

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 TwainToClipboard. In this case, the parameters specified in TwainScanZone are taken into account.
the image broadcasted by a "web camera" during the call to TwainToClipboard.
the first photo saved in a digital camera.
Remark: 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.

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

Component: wd260std.dll