EZTwain Pro User Guide

A developer's guide to the EZTwain library version 3.30 Finally, PDF/A and PDF Encryption.

Hyperlinks Author Revised Copyright Trademarks

EZTwain Pro page: http://www.dosadi.com/eztwain3.htm Support Forums: http://www.dosadi.com/forums Spike McLarty for Dosadi. 9/9/2008 2003-2008 by Dosadi. All rights reserved. EZTwain Pro, and Dosadi are trademarks of Dosadi. Microsoft and Windows are trademarks of Microsoft Corporation. All other trademarks are the property of their respective owners.

EZTwain User Guide

Table of Contents
Table of Contents.............................................................................................1 Introduction.....................................................................................................1 Overview.........................................................................................................2 EZTwain Components....................................................................................2 EZTwain Toolkit Directory Structure.................................................................3 How-To Guide..................................................................................................4 How To: Use the Code Wizard to get started.....................................................4 How To: Use EZTwain from other languages.....................................................6 How To: Statically Link to EZTwain..................................................................7 How To: Redistribute EZTwain with your Application..........................................8 How To: Obtain a License Key.........................................................................9 How To: Select a Device for Input.................................................................10 How To: Acquire an Image...........................................................................12 How To: Negotiate Scanning Parameters........................................................13 How To: Scan a Multipage Document.............................................................14 How To: Hide the Source User Interface.........................................................15 How To: Control a Document Feeder (ADF).....................................................16 How To: Skip Blank Pages............................................................................17 How To: Read Patch Codes...........................................................................18 How To: Append to PDF, TIFF & DCX Files......................................................19 How To: Check for Device On-Line.................................................................19 How To: Do Other Random Stuff...................................................................19 Function Reference.........................................................................................21 Functions Application Name & Licensing......................................................21 Functions Image Acquisition.......................................................................24 Functions Global Modes & Queries...............................................................31 Functions Post-Processing..........................................................................33 Functions Extended Image Information.......................................................37 Functions DIBs & Image Processing.............................................................40 Functions Clipboard..................................................................................63 Functions Barcode Recognition...................................................................67 Functions Optical Character Recognition (OCR) ............................................74 Functions File Uploading............................................................................98 Functions Image Viewing.........................................................................104 Functions Error Handling & Logging...........................................................107 Functions TWAIN State............................................................................109 Functions Capability................................................................................112 Functions Settings Dialog.........................................................................130 Functions Custom DS Data.......................................................................131 Functions Container................................................................................132 Functions Testing & Validation..................................................................136 Functions Obscure (Even for TWAIN).........................................................137 Functions Deprecated..............................................................................142 Glossary......................................................................................................143 Appendix 1 - History.....................................................................................149 Appendix 2 - Working with Containers.............................................................155 Appendix 3 - Multithreading with EZTwain .......................................................161 Appendix 4 - EZTwain Datatypes....................................................................163 Index..........................................................................................................165

EZTwain Pro User Guide

Introduction
This guide describes how to use the Dosadi EZTwain library to add scanning or image-acquisition to a Microsoft Windows application. If you dont know much about TWAIN, the image-input standard that EZTwain is built on, dont worry the necessary concepts and explanations are included. If you have used previous versions of EZTwain see Appendix 1, Recent Changes. What is EZTwain? EZTwain is a Windows DLL that provides an easy-to-use wrapper for the TWAIN API. TWAIN is the most widely supported API for controlling scanners, and downloading images from cameras. EZTwain makes TWAIN easier for developers by radically reducing their learning and programming effort which means fewer bugs, lower cost, and shorter schedules. With EZTwain, you can Acquire an image from a TWAIN-compliant device, bringing the image into memory or writing it immediately to a file, with one call. Select the output file format to be BMP, JPEG, PNG, DCX, TIFF, or PDF. Display the TWAIN dialog that allows the user to select among his or her TWAIN devices, or - enumerate the devices and present a list to the user, or select a specific device by name. Suppress the normal user interface presented by a device, and take control of the scanning process from your program. Restrict or pre-select the scanning mode (B&W, Grayscale, RGB Color), the bit-depth, resolution, transparent versus reflective media, brightness, contrast, threshold, auto-brightness, duplex, and any other options offered by the device through TWAIN. Detect and control a document feeder (ADF). Scan multiple pages, discard blank pages, deskew (straighten) crooked pages. Collect scans into multi-page TIFF, DCX, or PDF files. Load, examine, display, and write image files in all supported formats. Put an image on the Windows clipboard, or get an image from the clipboard. Query any property that your TWAIN device offers, and manipulate that property in any way allowed by TWAIN and the device. Upload images to a server via HTTP, in any supported file format.

Dosadi maintains, supports, and licenses EZTwain, as well as other tools for TWAIN developers. For more information, please visit www.dosadi.com.

Page 1

EZTwain Pro User Guide

Overview
EZTwain Components
EZTwain Executable Files Eztwain3.dll DLL containing the EZTwain Pro functions. It is not an ActiveX control or COM server, and does not need to be registered. Optional DLL. Required to read and write JPEG, TIFF or PDF format files. Optional DLL to read and write TIFF files. Requires EZJpeg.dll. Optional DLL to write PDF files and to a limited extent read them. Requires EZJpeg.dll. Optional DLL to read and write PNG files Optional DLL to read and write GIF files. Optional DLL to read and write DCX files. Optional DLL to provide barcode recognition. Optional DLL to provide network file transfer (HTTP) Optional DLL to provide OCR.

EZJpeg.dll EZTiff.dll EZPdf.dll EZPng.dll EZGif.dll EZDcx.dll EZSymbol.dll EZCurl.dll EZOcr.dll

The EZTwain Pro Toolkit installs these files into the Windows System folder, which is C:\WINDOWS\System32 on most versions of Windows, and into the folder called 'Redistributables' under the EZTwain Pro main folder, which is usually C:\Program Files\EZTwain See also: How to Redistribute EZTwain with your Application, page 8

Page 2

EZTwain Pro User Guide

EZTwain Toolkit Directory Structure

Toolkit Folders (What's Where) . (By default, C:\Program Files\EZTwain) EZTwain install folder - Contains the Licensing Wizard, EZTwain license, User Guide, Twirl TWAIN Probe, History.txt, Readme.txt. Contains eztwain.bas declaration file for use in VBA, and several small customer-donated Microsoft Access databases that use EZTwain. Eztwain3.lib and Eztwain.h, for use in Borland C++ Builder programs. EZTwain.h and EZTwain3.lib for Clarion EZTwain.cs declaration file for C# Sample C# program eztwain.h declarations for use with dBASE & co. EZTwain.pas declaration file and a small sample application for Borland Delphi 6. eztwain.lss declaration file for Lotus Notes/Domino. Eztwain.pl declaration file, and a small sample program in Perl. eztwain.inc declaration file. Eztwain.txt - declarations and constant definitions to use EZTwain from Sybase PowerBuilder. eztwain.i file containing external declarations to use EZTwain from Progress 4GL. Copies of all the redistributable EZTwain DLLs. Eztwain3.lib and compiled sample apps for MSVC++. contains EZT3MT.LIB - a static link library of Eztwain3.dll. Please read the How To: Statically Link to EZTwain Pro. EZTwain.bas declaration file, and a small sample application for Visual Basic EZTwain.vb declaration file for use in VB.NET Sample VB.NET program EZTwain header files for Microsoft Visual C++ 6.0. Visual FoxPro declaration file.

.\Access

.\BCB .\Clarion .\CSharp .\CSharp Sample .\dBASE .\Delphi .\LotusScript .\Perl .\PowerBASIC .\PowerBuilder .\Progress .\Redistributables .\Release .\Static

.\VB .\VB.NET .\VB.NET Sample .\VC .\VFP

Page 3

EZTwain Pro User Guide

How-To Guide
How To: Use the Code Wizard to get started
Our Code Wizard supports the following languages: Borland Delphi (5 thru 8) C# for .NET LotusScript Microsoft Visual C++ (6 or 7) with MFC Microsoft Visual C (6 or 7) PowerScript for PowerBuilder Visual Basic (5, 6 or 7) including VBA Visual FoxPro (7 & 8) VB.NET WinDev (English et Franais)

For these languages, you should launch the Code Wizard (under Start - Programs EZTwain) and step through it to generate code for some simple task like selecting the default TWAIN device, or doing a scan with default settings. The Wizard includes instructions for bringing EZTwain into your application. Then review the sections below to see if there are any specific comments for your language.

Microsoft Visual Basic 5, 6, or 7

Run the Code Wizard to get started - see above. Sample: The \vb folder contains a small EZTwain sample application called VBTwerp, which has been tested with Visual Basic 5. The EZTwain installer places the EZTwain3 DLLs in the System32 folder, so your program should not have trouble finding them. See Also: Converting between DIBs and VB Pictures (p. 47)

C# and VB.NET
Run the Code Wizard to get started - see above. In the EZTwain folder (usually under Program Files), there are sample programs in folders named: VB.NET Sample Application and CSharp Sample Application. From .NET, EZTwain is basically just a big friend class with a lot of public/static functions. There are a few points to be aware of: 1. All of the TWAIN_xxx functions have had the TWAIN_ prefix stripped, so they are just EZTwain.xxx. For example, TWAIN_Acquire(0,0) becomes EZTwain.Acquire(0,0). 2. All of the constants defined in EZTwain.vb or EZTwain.cs need to be qualified just as the functions do e.g. EZTwain.TWPT_BW, EZTwain.EZT_TEXT_NORMAL, and so on. Page 4

EZTwain Pro User Guide

3. Unfortunately, two functions, TWAIN_Set and TWAIN_Get, conflict with the VB.NET keywords 'Set' and 'Get', so they are aliased to EZTwain.SetCap and EZTwain.GetCap. You are not likely to need these, but just in case. 4. EZTwain works with quite a few kinds of 'platform' (native Win32) handles, such as DIB handles, HBITMAPs and HWND Window handles. These are pretty much all translated to System.IntPtr per Microsoft's recommendation. As a result you must be careful to read the documentation to see exactly which kind of handle you are - er - handling. Dont mix them up! 5. We provide a function DIB_ToImage that copies an EZTwain DIB into a .NET Image object, for VB.NET. Contact us if you need the equivalent code for C#. Please contact Dosadi technical support if you encounter any problems using EZTwain Pro 3 from .NET. We are committed to resolving such problems promptly.

Microsoft Visual FoxPro

Run the Code Wizard to get started - see above. For a nice introduction to using EZTwain from VFP, see this article by Mike Lewis of Mike Lewis Consultants Ltd: http://www.ml-consult.co.uk/foxst-29.htm See the general discussion under Redistributing EZTwain with an Application.

Borland Delphi
Run the Code Wizard to get started - see above. There is a very small Delphi EZTwain sample application, created with Delphi 6, in the EZTwain\Delphi folder, including the project file: You should just be able to double-click the project file to open the sample in Delphi. Caution: The sample converts images from the DIB format delivered by EZTwain, into the TBitmap format favored by Delphi. We do not recommend converting images from DIB to TBitmap and back because information (particularly DPI) can be lost if you do this.

Microsoft Visual C++

Run the Code Wizard to get started - see above. Note: It is possible to statically link EZTwain Pro, see How To: Statically Link to EZTwain, p 7.

LotusScript PowerScript - PowerBuilder

Run the Code Wizard to get started - see above. Note that as of EZTwain Pro 3.20b11 we provide one declaration files for PowerBuilder version 10, and another for prior versions of PowerBuilder, due to incompatible declaration syntax.

Page 5

EZTwain Pro User Guide

How To: Use EZTwain from other languages

LabVIEW
We do not offer any pre-written LabVIEW code, but several customers have used EZTwain from LabVIEW. For links and the most up-to-date information about using EZTwain from LabVIEW, visit our LabVIEW Support Page at: http://www.dosadi.com/ezt3labview.htm

Perl
We do not understand Perl! But one of our customers helped us create a Perl declaration file and a small sample. They can be found in the EZTwain toolkit folder \Program Files\EZTwain\Perl

Borland C++ Builder (BCB)

EZTwain Pro has been used successfully from BCB 6.0 The toolkit includes a header file EZTwain.h, and a link-library Eztwain3.lib, which by default is copied to this folder: \Program Files\EZTwain\BCB Warning: The default handling of floating-point exceptions is different in Microsoft languages, and Borland languages. Certain TWAIN device drivers will generate fatal run-time exceptions if they are invoked from Borland applications unless precautions are taken. See our advisory: http://www.dosadi.com/borland-issue.htm

Microsoft Access (VBA)

We dont claim any expertise with Microsoft Access, but several customers who are regular Access users have donated sample code for accessing (cough) EZTwain Pro. Their databases can be found in: \Program Files\EZTwain\Access

Clarion, dBASE (dBASE+, VDB), PowerBASIC, Progress 4GL

If you look in the toolkit folder \Program Files\EZTwain you will find sub-folders for these languages, and perhaps others. In those subfolders will be a file containing external declarations for all EZTwain functions. There are also blocks of constant definitions, which you may use at your convenience, and in some cases there are small sample programs.

Java
We do not provide a Java binding, but customers have suggested JNI, JNA, and JNative all as useful. Search our Forum for more details: http://www.dosadi.com/Forums/

Other languages
For other development platforms, please contact Dosadi support via our Forums (http://www.dosadi.com/forums) or via e-mail: [email protected]

Page 6

EZTwain Pro User Guide

How To: Statically Link to EZTwain

This section assumes you are using Microsoft Visual C/C++. For other languages or compilers, you are responsible for adapting the following advice. When you install the EZTwain Pro toolkit, you designate a main folder for the various developer files. Under that folder is a subfolder called Static containing a statically linkable library: EZT3MT.LIB. This library contains almost all (exceptions noted below) of the functions from Eztwain3.dll. Note: The static library directly supports only BMP file format: To read or write any other file format, the same DLLs as described in EZTwain Executable Files must be present and loadable. Use the function declarations from eztwain.h, and link to EZT3MT.LIB. EZT3MT.LIB will expect to link to LIBCMT or LIBCMTD, the multithreading version of the C runtime library. We urge you to configure your application or calling DLL for multithreading: EZTwain Pro does not multithread internally today, but this could change at any time. Contact [email protected] if this is a serious problem for you. Call EZTWAIN_Attach() before calling any other EZTwain function. Make a matching call to EZTWAIN_Detach() before terminating the application. TWAIN_ViewFile and DIB_View are missing - they depend on dialog resources that cannot be easily included in the .LIB

Page 7

EZTwain Pro User Guide

How To: Redistribute EZTwain with your Application

There are two main questions when redistributing EZTwain: Where to put the DLLs, and how to obtain a license (key).

Where to Put the DLLs

If you are preparing a software package to be distributed with EZTwain, you have three main alternatives: Alternative 1. Follow the lead of the EZTwain Developer Kit and install the EZTwain DLLs in the System (System32) folder. The sample apps and various definition files are set up for this, using unqualified references to eztwain3.dll. If you have your own installer, it must compare versions before overwriting the EZ*.DLL files in the system folder, and only overwrite a higher version with a lower after strenuous warnings to the user. This is a specific obligation under the EZTwain Pro License Agreement. Any responsible install tool will do this by default, or at least offer it as an option. This alternative leaves you exposed to the following risk: Another product could be installed after yours, replacing your EZTwain DLLs with higher-versioned ones. Or vice-versa: Your application could replace older DLLs installed by a previous application. Either way, if the new DLLs are not sufficiently backward compatible, one or both of the applications involved can stop working. Dosadi makes every effort to keep our DLLs backwards-compatible, but it cannot be guaranteed. This is one form of DLL Hell and is a risk with using any DLL installed in a System folder. Alternative 2. If your application compiles to an EXE file, you can install the EZTwain DLLs in the same folder as the .EXE. Use an unqualified DLL reference as in Alternative 1. Under this alternative, your application will always (we believe) load and use those specific DLLs. Alternative 3. For dynamic-binding languages like VB and FoxPro, you can use fully qualified paths for the EZTwain DLL If you decide to do this, replace all occurrences of Eztwain3.DLL in the definition file with the full path of the DLL .e.g. c:\Program Files\Eztwain\Release\Eztwain3.dll Under this alternative, your installer must install the EZTwain DLLs in the same specific folder on every target machine, or must have a way at run-time to find and load the DLLs.

Page 8

EZTwain Pro User Guide

How To: Obtain a License Key

Redistribution of the EZTwain DLLs is only allowed by the EZTwain Pro License under these circumstances: You (your organization) purchases a Single-Application Redistribution License key. You provide a title for your application, and you receive a numeric unlock key. The title and key are used by your software to unlock EZTwain at run-time. See details under TWAIN_ApplicationLicense in the Function Reference section below. For details and ordering information, run the Dosadi Licensing Wizard, or visit: http://www.dosadi.com/ezt3lic_1app.htm You purchase a Universal Redistribution License key. For this key, you provide a vendor name, and add a call to TWAIN_SetVendorKey in your software. See details under TWAIN_SetVendorKey in the Function Reference section below. For details and ordering information, run the Dosadi Licensing Wizard, or browse to: http://www.dosadi.com/ezt3lic_vendor.htm You purchase an In-House Application License (IHAL) for your organization. You provide the name of the organization when purchasing the license, and receive a corresponding numeric key. Call TWAIN_OrganizationLicense (22) with the organization name and numeric key to unlock EZTwain on computers owned and operated by the licensed organization. For details and ordering information, run the Dosadi Licensing Wizard, or visit: http://www.dosadi.com/ezt3lic_org.htm

Page 9

EZTwain Pro User Guide

How To: Select a Device for Input

Displaying the Select Source Dialog
You can implement the Select Source command with one EZTwain call: TWAIN_SelectImageSource(0); This function displays the TWAIN Select Source dialog, with a list of all the installed TWAIN Sources on the system:

The user can select the new default TWAIN device or, they can cancel. If they OK this dialog, TWAIN remembers the new default device. Note that the Select Source dialog lists Sources (TWAIN drivers), not physical devices: It will list devices even if they are currently off-line or unplugged. Also, two devices that use the same driver will only appear once in the TWAIN device list. Please dont make the user go through the Select Source dialog each time they want to acquire!

Page 10

EZTwain Pro User Guide

Enumerating the available sources

If you would like to display your own list of TWAIN Sources, or find out the exact name of a Source, you can use TWAIN_GetSourceList and TWAIN_GetNextSourceName. The Code Wizard, installed as part of the EZTwain Pro toolkit, will generate the code to do this in variety of languages.

Opening a Source by Name

If you would like to acquire from a specific device, you will need to know its exact name. You can enumerate the names of the installed devices - see above. Then you can open a specific source this way:

if (TWAIN_OpenSource(Logitech Camera) == 1) { TWAIN_AcquireToFilename(0, frame.bmp); }

This tries to open the named device, and if successful, acquires an image and stores it in a bmp file. All of the Acquire functions work this way If a source is open, they use it, and otherwise they open and use the default source.

Page 11

EZTwain Pro User Guide

How To: Acquire an Image

To acquire a single image from the default TWAIN device, using the devices user interface, and store it in a BMP file, call TWAIN_AcquireToFilename(0, filename.bmp) This makes an excellent test of: 1. Your ability to invoke EZTwain, 2. That EZTwain DLL (Eztwain3.dll) is where your program can find it, 3. TWAIN is correctly installed on the computer, and 4. The default TWAIN device being correctly installed and operational. A word about the default TWAIN device - If there is only one TWAIN device installed in the system, then that device is the default TWAIN device. Otherwise, it is the last TWAIN device selected by the user in the Select Source dialog. To acquire an image into memory:

hdib = TWAIN_Acquire(0); if (hdib != 0) { DIB_WriteToFilename(hdib, last_scan.tif); DIB_Free(hdib); hdib = 0; }

This acquires a single image from the default device, formats it in memory as a DIB, and returns a handle to it - A handle, not a pointer. Then it writes the DIB out as a TIFF file, and frees the DIB. Note that the returned object is a DIB. There is a Windows object commonly called a Bitmap, short for Device-Dependent Bitmap or DDB a DIB is not a DDB! A DIB is a completely different animal. If something goes wrong with the transfer, the return value will be NULL (0). The DIB_Free call is needed to release the memory holding the image. If you dont do that, the image sits around taking up memory until your program exits.

Page 12

EZTwain Pro User Guide

How To: Negotiate Scanning Parameters

TWAIN requires, reasonably enough, that you must have a Source open before you can ask it about its settings and properties, called capabilities in TWAIN-speak. TWAIN also imposes the restriction that settings can only be set while the Source is open and before it has been enabled. Enabled in TWAIN means given the go-ahead to acquire images. To cut to the chase, heres a C fragment for scanning a 1-bit, 300dpi, B&W image:

if (TWAIN_OpenDefaultSource()) { // DS is now in State 4 (Open) TWAIN_SetPixelType(TWPT_BW); TWAIN_SetBitDepth(1); // (probably redundant for BW) TWAIN_SetUnits(TWUN_INCHES); TWAIN_SetResolution(300.0); hdib = TWAIN_Acquire(0); }
This code does no error checking on the Set functions, even though some of them will certainly fail on some devices. For example, almost any webcam will reject a pixel type of TWPT_BW, and probably a resolution setting of 300 it might reject any attempt to set resolution. It is recommended to select a pixel type first, then to set the bit depth some devices maintain bit depths for each pixel type. Setting the units to inches is a precaution that introduces interesting issues. In theory, resolution is defined as samples per unit of measure. So when we set a resolution of 300, we are setting 300 dpi only if the current unit of measure is inches (dpi = dots per inch, right?) If we are in a metric country and theres only one country that isnt metric then the DS might be configured to use centimeters, and 300 would mean 300 samples per centimeter. In practice, TWAIN specifies the default unit of measure as inches, so almost all Sources open with their units set to inches. However some webcams and video capture devices open with units set to pixels! Technically non-compliant, these devices are likely to reject any attempt to set their resolution anyway.

Page 13

EZTwain Pro User Guide

How To: Scan a Multipage Document

Multipage files are image files that can hold multiple pages or sequential images. The multipage file formats supported by EZTwain are TIFF, PDF, and DCX. DCX is rarely used so we will not mention again. To scan from the default TWAIN device into a multipage TIFF file takes one call: TWAIN_AcquireMultipageFile(hwnd, multipage.tif); The first parameter is the window handle of your main window if you cant easily obtain this, just pass a 0 - EZTwain will use the handle of the active window if any, or it will create an invisible window if there is no active window. The second parameter is the filename to create - EZTwain uses the extension to select the format of the file: .TIF, .TIFF, or .MPT means write a TIFF file, .PDF means write a PDF, etc. TWAIN_AcquireMultipageFile will present the scanners user interface, and will accept scans from the scanner (or images from a camera or webcam) until the user closes the scan dialog. A few devices will close their window automatically after sending one image - in some cases EZTwain can detect this and will prompt the user asking if there are more images. All of this is invisible to your application. If you do not want to display the devices user interface, you can use code like the following. If the default TWAIN device is a scanner with an Automatic Document Feeder (ADF), this code will scan all the pages in the feeder:

if (TWAIN_OpenDefaultSource()) { TWAIN_SetHideUI(1); // ask for no user interface TWAIN_SetResolution(300); // ask for 300 DPI TWAIN_SetPixelType(TWPT_BW); // black & white TWAIN_SelectFeeder(1); // from feeder (if possible) TWAIN_EnableDuplex(1); // both sides (if supported) TWAIN_AcquireMultipageFile(hwnd, multipage.tif); } if (TWAIN_LastErrorCode() != 0) { TWAIN_ReportLastError(Error during scanning.); }
If the current TWAIN device is a flatbed scanner, this code will immediately scan from the flatbed, then display a small message box asking if there are more pages to scan. As long as the user answers Yes, the TWAIN_AcquireMultipageFile function will continue to scan another page. Its important to specify at least the resolution and pixel type when the scanner user interface is suppressed, otherwise you have no way of knowing what settings the scanner will use.

Page 14

EZTwain Pro User Guide

How To: Hide the Source User Interface

In theory
Make the following call before any Acquire calls, and images will arrive from your device with no distracting dialogs or windows on screen: TWAIN_SetHideUI(1)

In practice
Some devices will refuse to cooperate and will display their user interface (UI) anyway. A few particularly bad TWAIN device drivers will crash when used this way. Even in No-UI mode, many devices will display a status or progress box while scanning or transferring data. Sometimes the progress box can be suppressed [see TWAIN_SetIndicators, p. 120.] If the device is not connected and powered up, if the paper jams, or if anything else happens that requires human attention, most devices will display an error dialog. Suppressing such error messages requires low-level Windows programming outside the scope of TWAIN or EZTwain. You can count on almost all desktop scanners, departmental scanners, and highvolume scanners to scan well without showing their UI. Some webcams will transfer with no UI, for example the Logitech QuickCams. You cannot count on a digital still camera (DSC) to transfer all its images from memory in No-UI mode. Last time we checked (2005) most DSCs ignore the request to hide their UI. If you must automate a device that insists on displaying its user interface (almost any webcam, for example) you can try the function TWAIN_AutoClickButton.

Page 15

EZTwain Pro User Guide

How To: Control a Document Feeder (ADF)

Heres a sample of code to drive a scanner with an automatic document feeder, suppressing the Source user interface: if (!TWAIN_OpenDefaultSource()) { return; // unable to open device? } TWAIN_SetHideUI(1); // hide the user interface TWAIN_SetMultiTransfer(1); // leave device open after Acquire TWAIN_SelectFeeder(1); // tell device: use feeder TWAIN_SetAutoFeed(1); // tell device: feed automatically TWAIN_SetAutoScan(1); // tell device: scan ahead TWAIN_EnableDuplex(1); // tell device: both sides, if you can // OK - start scanning do { HANDLE hdib = TWAIN_Acquire (0); if (hdib==0) { // something went wrong break; } ProcessThisPage(hdib); DIB_Free(hdib); } while (TWAIN_State() > 5); TWAIN_CloseSource(); Be aware that TWAIN_SelectFeeder can fail on a scanner that looks for all the world to have a document feeder. One of the biggest players in consumer scanners has shipped a variety of sheet-feeding models that deny (through TWAIN) having feeders. The above code fragment will probably drive such devices, even though both the Feeder-related functions fail. TWAIN_SetAutoFeed and TWAIN_SetAutoScan can fail, this is harmless. Scanners that support this feature will scan at full speed when these are set, and scanners that dont will still feed pages when Acquire requests them.

Page 16

EZTwain Pro User Guide

How To: Skip Blank Pages

Starting with EZTwain 3.10, if you are using TWAIN_AcquireMultipageFile, you can skip blank pages by simply calling

TWAIN_SetBlankPageMode(1)
This tells AcquireMultipageFile to detect and discard blank pages. Use TWAIN_SetBlankPageThreshold to adjust the threshold for blankness. If you are not using AcquireMultipageFile, you will need to call functions to detect blank pages and handle them in your control flow. Below we have taken a standard multipage scanning loop in Visual Basic generated by the Code Wizard, and added code to ignore blank pages:

Dim fileName As String Dim hdib As Long fileName = "c:\mydoc.pdf" Output to PDF Call TWAIN_SetHideUI(0) Hide scanner dialog If TWAIN_OpenDefaultSource()=1 Then Call TWAIN_SelectFeeder(1) Pull from ADF Call TWAIN_SetXferCount(-1) All available pages Call TWAIN_SetAutoScan(1) Scan ahead if you can Call TWAIN_SetMultiTransfer(1) Allow multi acquire Call TWAIN_BeginMultipageFile(fileName) Do hdib = TWAIN_Acquire(Me.hwnd) Get next image If hdib=0 Then Exit Do End If We decide that < 2% ink coverage means blank. Only write non-blank pages to file: If Not DIB_IsBlank(hdib, 0.02) Then Call TWAIN_DibWritePage(hdib) End If Always remember to free the image from memory: Call DIB_Free(hdib) Loop While TWAIN_State()>=5 Call TWAIN_CloseSource() Call TWAIN_EndMultipageFile() End If If TWAIN_LastErrorCode()<>0 Then Call TWAIN_ReportLastError("Scan error.") End If

Page 17

EZTwain Pro User Guide

How To: Read Patch Codes

We'll need to enable patch code detection, by setting the TWAIN capability ICAP_PATCHCODEDETECTIONENABLED to TRUE. With the scanner open in EZTwain, this would be something like: TWAIN_SetCapability(ICAP_PATCHCODEDETECTIONENABLED, 1) or EZTwain.SetCapability(ICAP_PATCHCODEDETECTIONENABLED, 1) Then we need to tell EZTwain to ask for 'extended image info' after each scan, specifically the patch code. Something like this: TWAIN_EnableExtendedInfo(TWEI_PATCHCODE, 1) That 1 may need to be TRUE, True or true, depending on programming language. After each image is received by using TWAIN_Acquire or similar single-image scanning function, you can read the patch code that was found, if any, with code similar to this: If TWAIN_ExtendedInfoItemCount(TWEI_PATCHCODE) > 0 Then one or more patch codes found - assume only 1 for now! patch_code = TWAIN_ExtendedInfoInt(TWEI_PATCHCODE, 0) According to the TWAIN standard, the returned patch codes are: TWPCH_PATCH1 1 TWPCH_PATCH2 2 TWPCH_PATCH3 3 TWPCH_PATCH4 4 TWPCH_PATCH6 5 genius... TWPCH_PATCHT 6

Page 18

EZTwain Pro User Guide

How To: Append to PDF, TIFF & DCX Files

When the function TWAIN_SetFileAppendFlag is called with a non-zero argument, it tells EZTwain to append to existing PDF, TIFF and DCX files, instead of overwriting their contents. Example:

TWAIN_SetFileAppendFlag(1); TWAIN_AcquireMultipageFile(0, papertrail.pdf);

This will scan pages from the default TWAIN device, appending them to the file papertrail.pdf until the operator closes the device dialog. The effect of adding the call to TWAIN_SetFileAppendFlag is that if papertrail.pdf already exists the new pages are added to it. If papertrail.pdf does not exist, it is created. The File Append Flag applies to TWAIN_AcquireMultipageFile as above, and to any other EZTwain function writing a PDF, TIFF or DCX file. Obscure Exception: This cannot be used with TWAIN_AcquireFile, because with that function the TWAIN driver writes the file, not EZTwain.

How To: Check for Device On-Line

You cant! TWAIN added a capability for this rather late in the game, and did a bad job: Very few TWAIN devices handle this correctly. Summary: There is no known general way to check if a TWAIN device is on-line.

How To: Do Other Random Stuff

Note: Your syntax may vary. In some languages, TWAIN_function is called as EZTwain.function, and all other functions and constants may need to be prefixed with EZTwain. Some EZTwain Pro functions accept or return boolean values: Depending on your language these may be 0 and 1, true and false, TRUE and FALSE, etc. To turn off the 'auto rotation' feature of certain scanners, such as the Canon network scanners: TWAIN_SetCapBool(ICAP_AUTOMATICROTATION, 0)

Page 19

EZTwain Pro User Guide

Function Reference
Functions Application Name & Licensing
Note: If you installed the EZTwain Pro developer kit on your system, the terms of the EZTwain License are available under Start Programs Dosadi, in License.txt in the EZTwain folder, and on the web at: http://www.dosadi.com/EZT3_License.pdf The home page for EZTwain Pro licensing is: http://www.dosadi.com/ezt3lic.htm See How To: Obtain a License Key, page 9

TWAIN_SetAppTitle
void TWAIN_SetAppTitle(string Title) Sets the application title, which is used several ways: As the title (caption) of any message boxes displayed by EZTwain. By a few Sources, in their progress box e.g. Transferring image to <app title> In theory, it could be used by a Source to react specially to an application.

If you call TWAIN_ApplicationLicense, you do not need to call TWAIN_SetAppTitle. If you do not set the application title at all, the application is given a tacky default title such as Application using EZTwain.

TWAIN_ApplicationLicense
void TWAIN_ApplicationLicense(string pzAppTitle, int nAppKey)
Sets the title of the application (as far as EZTwain is concerned) and unlocks EZTwain using a Single Application Redistribution Key. It unlocks EZTwain Pro, if the numeric key (nAppKey) matches the application title. Make sure you use the exact string used to purchase the license it is listed with the key in the grant-of-license e-mail. This should be the first EZTwain call your application makes, other than TWAIN_LogFile.

TWAIN_SetApplicationKey
void TWAIN_SetApplicationKey(int nAppKey)
Similar to TWAIN_ApplicationLicense above, but called after TWAIN_SetAppTitle or TWAIN_RegisterApp. It unlocks EZTwain using a Single Application Redistribution Key, if the key matches the application title you have set.

TWAIN_SetVendorKey
void TWAIN_SetVendorKey(string pzVendorName, int nKey)
Unlocks EZTwain using a Universal Redistribution License key Sometimes also called a Vendor License Key. Make sure you use the exact string that was entered for Vendor on the order it is listed with the key in the grant-of-license e-mail. Page 21

EZTwain Pro User Guide

This should be the first EZTwain call your application makes, except for TWAIN_LogFile. Use TWAIN_SetAppTitle to tell EZTwain the name of the application.

TWAIN_OrganizationLicense
void TWAIN_OrganizationLicense(string pzOrganization, int nKey)
Unlocks EZTwain using an In-House Application License key Sometimes also called an Organization License key. Make sure you use the exact string that was entered for Organization on the order it is listed with the key in the grant-of-license email. This should be the first EZTwain call your application makes, except for TWAIN_LogFile. Use TWAIN_SetAppTitle to tell EZTwain the name of the application.

Page 22

EZTwain Pro User Guide

TWAIN_SingleMachineLicense
BOOL TWAIN_SingleMachineLicense(string Prompt)
This function is for use in applications that will deployed on a small number of computers, using the EZTwain Pro Single Machine License which is a per-machine license. Call this function when your application starts up, perhaps even during installation of your application, and it will prompt as needed for a license key on each machine. Previously a Single Machine License could only be installed on a computer by first installing the entire EZTwain Pro Developer Toolkit, then running the EZTwain Pro Licensing Wizard. This function replaces that procedure, allowing the developer to build the licensing process into his or her application. When called, this function checks to see if EZTwain Pro is licensed to run on this computer at this time. 1. If the running copy of EZTwain is licensed in any way - including a trial license - this function silently returns TRUE(1) to the caller. 2. If no license is found, this function displays a 'license needed' dialog, with the Prompt argument at the top of the dialog. If an application title has been set with TWAIN_SetAppTitle, it is used as the title of the dialog. The user is told how to obtain a license key and how to enter it. Once a key is entered and found valid, it is stored on the computer and the function returns TRUE(1). Note: For this function to accept and store a license key, it must be running with Administrative privileges. 3. If the user cancels the licensing dialog, this function will normally return FALSE(0), which means that EZTwain is not licensed to run on the computer. You can use the Prompt argument to direct users to an in-house support person who can help resolve licensing problems. For example:

if (!TWAIN_SingleMachineLicense(Contact Willy Codewell x8000!)) { exit(255); }

If the Prompt string is empty, a default prompt similar to the following is used: "This application (<apptitle>) uses EZTwain Pro, which requires a valid numeric License Key."

Page 23

EZTwain Pro User Guide

Functions Image Acquisition

General Comments
EZTwain is built on a principal of brevity: You should only need to make calls or pass parameters, where EZTwain cannot reasonably guess what you want. Advice: When developing, we strongly suggest that you start with a simple call to TWAIN_AcquireToFilename (if you need a file), TWAIN_AcquireMultipageFile (to scan a multipage document) or TWAIN_Acquire (if you need an image in memory.) Then add additional calls one by one to get the exact behavior you ultimately want. By default, all Acquire functions shut down TWAIN before returning. If you are doing a series of transfers from the same device, it is much faster to leave the device open between transfers. You can use a multipage scanning function to do this, or use TWAIN_SetMultiTransfer (p 31) to keep the device open for multiple transfers. All Acquire functions load TWAIN and then open and enable the default Source, if needed. EZTwain goes to great lengths to track the TWAIN State, and will generally move TWAIN automatically from state to state as needed. For example, if you start by calling TWAIN_OpenSource, EZTwain makes the necessary calls to transition from State 1 to State 4. If you then call an Acquire function, EZTwain sees that there is a Source open, and proceeds with acquisition from that device. By default, the Acquire functions tell the device to display its user interface. Use TWAIN_SetHideUI to change this.

Page 24

EZTwain Pro User Guide

TWAIN_AcquireToFilename
int TWAIN_AcquireToFilename(HWND hwndApp, string pszFile) Acquire an image and save it to a file. If the filename contains a standard extension (.bmp, .jpg, .jpeg, .tif, .tiff, .png, .pdf, .gif, .dcx) then the file is saved in the implied format. Otherwise the file is saved in the default save format see TWAIN_SetSaveFormat (p 88). If pszFile is NULL or an empty string, the user is prompted for the file name and format with a standard Save File dialog. Only available and appropriate formats are presented in the Save File dialog. In this case if you need to know the filename the user chose, you can call TWAIN_LastOutputFile (p ). See also TWAIN_Acquire below. Return values: 0 success. -1 the Acquire failed. -2 file open error (invalid path or name, or access denied) -3 invalid DIB, or image incompatible with file format, or... -4 writing failed, possibly output device is full. -10 user cancelled File Save dialog The minimal use of EZTwain is to call this function with null arguments:

ErrCode = TWAIN_AcquireToFilename(0, )

TWAIN_Acquire
HANDLE TWAIN_Acquire (HWND hwndApp)
Acquires a single image, from the currently selected Source, using EZTwain's preferred transfer mode. The return value is a handle to global memory containing a DIB, a DeviceIndependent Bitmap. There are numerous functions to examine, modify, and save these DIB images. Remember to call DIB_Free on each DIB when you are done with it! To acquire an RGB image with 8 bits/channel, you need to do something like this: TWAIN_SetPixelType(TWPT_RGB); hdib = TWAIN_Acquire(hwnd) if (hdib) { // process image DIB_Free(hdib); }

Page 25

EZTwain Pro User Guide

TWAIN_AcquireMultipageFile
int TWAIN_AcquireMultipageFile(HWND hwndApp, string Filename) Acquire multiple pages into a single output file. If the filename ends with a recognized extension, the file is written in the implied format: .TIF/.TIFF/.MPT => TIFF, .DCX => DCX format, and .PDF => PDF. If the filename has no extension, the file is written in the current default multipage format and the corresponding extension is appended: .TIF, .DCX or .PDF. See TWAIN_SetMultipageFormat (p 32). If Filename is NULL or the empty string, the user will be prompted for the file name. The only format offered will be the current default multipage format. If you use this feature, you can call TWAIN_LastOutputFile to obtain the actual filename. Return values: 0 success -1 the Acquire failed. -2 file open error (invalid path or name, or access denied) -3 invalid DIB -4 writing failed, possibly output device is full. -10 user cancelled File Save dialog Other functions that affect this function: TWAIN_SetHideUI hide or show the scanner's user interface. TWAIN_SetAutoDeskew automatically deskew each page. TWAIN_SetBlankPageMode discard blank pages. TWAIN_SetMultiTransfer leave device open when the function returns. If TWAIN_SetHideUI is 0 [the default case] then the device UI is shown, and AcquireMultipageFile will transfer images until the user closes the device dialog. If SetHideUI is 1, then the device UI is hidden and AcquireMultipageFile will transfer images until the device indicates that it has no more images available (technically, until it goes to State 5). Exception: In the case of a device that does not have a feeder, AcquireMultipageFile will prompt the user after each page, asking if there are more pages to scan. Caution: It is not recommended to use this function on webcams with SetHideUI(1). A few will crash, others may supply images endlessly. TWAIN_BlankDiscardCount returns the number of blank pages discarded by TWAIN_AcquireMultipageFile. TWAIN_MultipageCount can be called during or after a multipage acquire: It returns the number of images written to the most recently created multipage file. See also TWAIN_AcquireCount just below. If you want to set scanning parameters (resolution, pixeltype...) first open the source (see OpenDefaultSource or OpenSource) then negotiate the settings using the capability functions, and then call AcquireMultipageFile.

Page 26

EZTwain Pro User Guide

TWAIN_AcquireImagesToFiles
int TWAIN_AcquireImagesToFiles(HWND hwndApp, string Filename)
Similar to TWAIN_AcquireMultipageFile above, but writes each image to a separate file with an auto-numbered name. If the filename is NULL or points to the empty string, the user is prompted for the name of the first file using a Save dialog. As with TWAIN_AcquireToFilename, if the filename contains a standard extension (.bmp, .jpg, .jpeg, .tif, .tiff, .png, .pdf, .gif, .dcx) then the file is saved in the implied format. Otherwise the file is saved in the default save format see TWAIN_SetSaveFormat (p 88). The first image acquired is written to the specified filename. The filename of each subsequent image is generated by this algorithm: 1. If the previous filename, excluding extension, does not end in one or more digits, then it is treated as if it ended with '0'. 2. If the previous name, excluding extension, ends in a sequence of d digits specifying the number n, then the next image filename is created by replacing the sequence of digits with a sequence of digits representing the number n+1, padded with leading 0's to make it at least d digits long. Examples Filename (1st File) Document.tif Page98.jpg Invoice00001.pdf

2nd File Document1.tif Page99.jpg Invoice00002.pdf

3rd File Document2.tif Page100.jpg Invoice00003.pdf

Return values: 0 The number of images (files) written. This could be 0 if the scanner dialog is displayed and the user closes the dialog without any scans, or if blank pages are being discarded and all pages of the scanned document test as blank. <0 An error. The codes are the same as TWAIN_AcquireMultipageFile. For more detailed error information, use TWAIN_ReportLastError, TWAIN_LastErrorCode, etc. See also TWAIN_AcquireCount and TWAIN_BlankDiscardCount.

Page 27

EZTwain Pro User Guide

TWAIN_AcquireCount
int TWAIN_AcquireCount()
Returns the number of images received from the scanner during the most recent call to TWAIN_AcquireMultipageFile or TWAIN_AcquireImagesToFiles.

TWAIN_BlankDiscardCount
int TWAIN_BlankDiscardCount()
Returns the number of pages discarded as blank during the most recent call to TWAIN_AcquireMultipageFile or TWAIN_AcquireImagesToFiles. See TWAIN_SetBlankPageMode (p 33).

Page 28

EZTwain Pro User Guide

TWAIN_AcquireNative
HANDLE TWAIN_AcquireNative(HWND hwndApp, unsigned wPixTypes) Acquires a single image, from the currently selected Source, using Native Transfer Mode. It waits until the source closes (if it's modal) or forces the source closed if not. The return value is a handle to the acquired image, in DIB format. Only one image can be acquired per call. The return value is a handle to global memory containing a DIB - a DeviceIndependent Bitmap. Numerous EZTwain functions can be used to examine, modify, and save these DIBs. Remember to use DIB_Free to free each DIB when you are done with it - these things can eat up a lot of memory. For the 2nd parameter, you can OR or add together the following masks to indicate what kind(s) of image you prefer to receive. Caution: Some TWAIN devices will ignore your preference here. If you dont care, or have already negotiated the pixel type, just specify TWAIN_ANYTYPE (0) for the 2nd parameter. It is never safe to assume that a random device will respect your requested pixel type, bit depth, resolution, or anything else: If you care, check the parameters of the DIB using the DIB functions. #define #define #define #define TWAIN_BW TWAIN_GRAY TWAIN_RGB TWAIN_PALETTE 0x0001 0x0002 0x0004 0x0008 0x0000 // // // // 1-bit per pixel, B&W 1,4, or 8-bit grayscale 24-bit RGB color 1,4, or 8-bit palette

#define TWAIN_ANYTYPE

// any of the above (use by itself)

TWAIN_AcquireMemory
HANDLE TWAIN_AcquireMemory (HWND hwnd) Like TWAIN_Acquire, but always specifies a 'memory mode' transfer. Note: This function must be used to transfer 16-bit per channel images (16-bit grayscale, 48-bit color) assuming your scanner supports this. These deep images are returned in a DIB format that most software (including Windows) will not understand but most of EZTwains DIB_ functions will operate on these deep DIBs, and they can be written to TIFF.

Page 29

EZTwain Pro User Guide

TWAIN_AcquireFile
int TWAIN_AcquireFile(HWND hwndApp, int nFF, string pszFile)
Acquire one image and write it to a file using TWAIN File Transfer Mode. This is an exotic transfer mode, not supported by all TWAIN devices. Do not use this function unless you have a specific reason and understand the consequences. If you just want to scan one image or page to a file, use TWAIN_AcquireToFilename. Warning: File Transfer Mode is not supported by all TWAIN devices, and when it is supported, often BMP is the only supported file format. You can open a Source and then use TWAIN_SupportsFileXfer to see if the DS supports File Transfer Mode. You can use TWAIN_Get(ICAP_IMAGEFILEFORMAT) to get an enumeration of the available file formats, and CONTAINER_ContainsValue to check for a particular format you are interested in. See Appendix 2 - Working with Containers, p 155. nFF can be any file format supported by the DS, see the TWFF_* constants in twain.h for the list of allowed formats. A compliant DS should at least support TWFF_BMP, but as usual there are no guarantees. If pszFile is NULL or an empty string, the user is prompted for the file name in a standard Save File dialog. If you use this feature, you can call TWAIN_LastOutputFile to obtain the actual filename. Return values (Note, this is not an error code like AcquireToFilename!) TRUE(1) for success FALSE(0) for failure Use GetResultCode/GetConditionCode for details. If the user cancels the Save File dialog, the result code will be TWRC_CANCEL

TWAIN_AcquireToClipboard
int TWAIN_AcquireToClipboard(HWND hwndApp, unsigned wPixTypes)
Like AcquireNative, but puts the resulting image, if any, into the system clipboard as a CF_DIB item. If this call fails, the clipboard is either empty or retains its previous content. Returns TRUE (1) for success, FALSE (0) for failure. Useful for environments like Visual Basic where it is hard to make direct use of a DIB handle. TWAIN_AcquireToClipboard uses TWAIN_AcquireNative and DIB_PutOnClipboard.

Page 30

EZTwain Pro User Guide

Functions Global Modes & Queries

TWAIN_EasyVersion
int TWAIN_EasyVersion()
Returns the version number of EZTwain Eztwain3.dll, multiplied by 100. So e.g. 237 as a return value means EZTwain Version 2.37

TWAIN_IsAvailable
int TWAIN_IsAvailable()
Call this function any time to find out if TWAIN is installed on the system. It takes a little time on the first call, after that it's extremely fast. It returns 1 if the TWAIN Source Manager is installed and can be loaded, 0 otherwise.

TWAIN_SetHideUI / TWAIN_GetHideUI
TWAIN_SetHideUI(int fHide) int TWAIN_GetHideUI() These functions control the 'hide source user interface' flag. This flag is initially FALSE(0), but if you set it non-zero, then when a source is enabled it will be asked to hide its user interface. Note this is a request - some sources will ignore it. See: How To: Hide the Datasource User Interface. If the user interface is hidden, you will probably want to set at least some of the basic acquisition parameters yourself see Negotiating Scanning Parameters . See also: HasControllableUI

TWAIN_SetMultiTransfer / TWAIN_GetMultiTransfer
TWAIN_SetMultiTransfer(int fYes) int TWAIN_GetMultiTransfer() These functions query and set the 'multiple transfers' flag. By default, the multi-transfer flag is FALSE(0). This means that EZTwain closes down TWAIN after each image transfer (TWAIN_AcquireXXX). If the multi-transfer flag is non-zero: After an Acquire, the Source is left open and enabled to allow additional images to be acquired in the same session. The programmer may need to close the Source after all images have been transferred, for example by calling TWAIN_CloseSource or TWAIN_UnloadSourceManager See How To: Transfer Multiple Images

Page 31

EZTwain Pro User Guide

TWAIN_DisableParent / TWAIN_GetDisableParent
void TWAIN_DisableParent(int fYes) int TWAIN_GetDisableParent (void)
Disable the parent window during all TWAIN_Acquire functions. (The parent window is the window you pass to the Acquire function. Typically this is your main application window or dialog.) By default this setting is TRUE - the parent window, if you pass it in, is disabled during an Acquire. Note 1: If you set this to FALSE, your window can receive user input while an Acquire is in progress, and your code must be prepared for this. Note 2: Some TWAIN Sources will disable the parent window on their own, and EZTwain cannot prevent this.

TWAIN_SetMultipageFormat TWAIN_GetMultipageFormat
int TWAIN_SetMultipageFormat(int nFF) int TWAIN_GetMultipageFormat()
Select/query the default multipage file save format, the file format used to write multipage files when the file format cannot be inferred from the file extension. If you use a recognized extension in the name of your multipage file - such as .tif, .tiff, .mpt, .pdf or .dcx, then the file will be written in the implied format. The file extension overrides SetMultipageFormat. The default when EZTwain is loaded is MULTIPAGE_TIFF. Multipage format values: 0 MULTIPAGE_TIFF 1 MULTIPAGE_PDF 2 MULTIPAGE_DCX SetMultipageFormat returns: 0 success, -1 invalid/unrecognized format (bad parameter value) -3 format is currently unavailable (missing/bad DLL) -7 Multipage support is not installed.

Page 32

EZTwain Pro User Guide

Functions Post-Processing
Post-processing is the industry term for everything you do to an image after it has been scanned or captured, before you store it or pass it on.

TWAIN_SetAutoCrop/TWAIN_GetAutoCrop
TWAIN_SetAutoCrop(int nMode) int TWAIN_GetAutoCrop()
Select the auto-crop mode. Auto-crop mode attempts to crop off very dark areas on the outside of each incoming image during scanning. The available auto-crop modes are: 0 no auto crop. 1 auto crop using software algorithm

TWAIN_SetAutoContrast/TWAIN_GetAutoContrast
TWAIN_SetAutoContrast(int nMode) int TWAIN_GetAutoContrast()
Select the auto-contrast mode. Auto-contrast mode attempts to automatically improve the contrast of each incoming image during scanning. It works best (EZTwain Pro 3.20 and earlier) on text documents autocontrast on photos is rather iffy. See DIB_AutoContrast for more details. The available auto-contrast modes are: 0 no auto contrast. 1 auto contrast using software algorithm

TWAIN_SetAutoDeskew/TWAIN_GetAutoDeskew
TWAIN_SetAutoDeskew(int nMode) int TWAIN_GetAutoDeskew()
Select the 'auto-deskew' mode. Auto-deskew attempts to straighten up scans that are slightly crooked, up to about 10 degrees. The available auto-deskew modes are: 0 no auto deskew. 1 auto deskew using software algorithm

TWAIN_SetBlankPageMode / TWAIN_GetBlankPageMode
TWAIN_SetBlankPageMode(int nMode) int TWAIN_GetBlankPageMode()
Set or get the Skip Blank Pages mode. When this mode is 1, blank pages are automatically discarded by TWAIN_AcquireMultipageFile. When this mode is 0 (the default), EZTwain does not look for blank pages or treat them in any special way. See TWAIN_SetBlankPageThreshold (below) for more details.

Page 33

EZTwain Pro User Guide

TWAIN_SetBlankPageThreshold / TWAIN_GetBlankPageThreshold
TWAIN_SetBlankPageThreshold(double dDarkness) double TWAIN_GetBlankPageThreshold()
Set or get the blank page threshold, which affects the operation of Skip Blank Pages mode. The blank page threshold is a number between 0 and 1.0. If the number of dark pixels on a page divided by the total number of pixels on the page is less than this threshold, the page is considered blank. The initial blank page threshold is: 0.02 (= 2% dark pixels). See DIB_IsBlank (p 60) and DIB_Darkness (p 60) for more details about the algorithm for computing dark pixels.

TWAIN_SetAutoOCR / TWAIN_GetAutoOCR
TWAIN_SetAutoOCR(int nMode) int TWAIN_GetAutoOCR() Sets or gets the auto-OCR mode. By default this mode is OFF(0). When this mode is on(1), EZTwain applies OCR, if available, to each incoming scanned page or image and temporarily stores the result. Also in this mode, if you scan directly to PDF format using TWAIN_AcquireToFilename or TWAIN_AcquireMultipageFile, the OCR'd text is written invisibly to each PDF page, to facilitate indexing and searching. If you are scanning individual pages you can call OCR_Text or OCR_GetText to retrieve the text found on the last scanned page. The currently selected OCR engine is used: See OCR_SelectEngine and related functions. Caution: If OCR fails for some reason in auto-OCR mode, an error is recorded (see TWAIN_LastErrorCode, TWAIN_ReportLastError) but the scanning function may report success.

TWAIN_SetAutoNegate/TWAIN_GetAutoNegate
TWAIN_SetAutoNegate(BOOL bYes) BOOL TWAIN_GetAutoNegate()
Controls the 'auto-negate' mode. Unlike most post-processing modes, this mode is on by default. Auto-negate mode analyzes each incoming B&W (1-bit/pixel) image during scanning. If the image is more than 80% black, it is negated - black and white are reversed. A surprising number of scanners incorrectly deliver negative images under certain circumstances, and this mode compensates for that. The available auto-negate modes are: 0 no auto negate. 1 auto negate (default)

Page 34

EZTwain Pro User Guide

Source (Device/Driver) Selection

TWAIN_SelectImageSource
int TWAIN_SelectImageSource(HWND hwnd) This function posts the Source Manager's Select Source dialog box, which allows the user to see and possibly change the default TWAIN device for their computer. Note: If only one TWAIN device is installed on a system, it is selected automatically, so there is no need for the user to do Select Source. You should not require your users to do Select Source before Acquire. Note that this dialog is displayed by the TWAIN Source Manager (twain_32.dll) not by EZTwain, and we have no direct control over its size, location, layout, etc. If you want a different UI, you can create your own using the functions below. It usually works well to pass a 0 to this function: EZTwain then finds and refers to the Foreground Window, and the Select Source dialog acts as a modal child of that window. If for some reason that isnt what you want, youll need to pass another valid HWND (Windows window-handle) to this function. Returns TRUE(1) if the user OKd a selection, FALSE(0) if: a) The user cancelled the dialog b) The Source Manager found no Sources installed c) There was a failure before the Select Source dialog could be posted To enumerate the available Sources, see the following two functions.

TWAIN_GetSourceList
int TWAIN_GetSourceList(void) Fetches the list of sources into memory, so they can be returned one by one by TWAIN_GetNextSourceName, below. Returns TRUE (1) if successful (at least one Source was found), FALSE (0) otherwise.

TWAIN_GetNextSourceName/TWAIN_NextSourceName
int TWAIN_GetNextSourceName(LPSTR pzName) string TWAIN_NextSourceName() TWAIN_GetNextSourceName copies the next source name in the list into pzName up to 32 characters (ANSI) plus a terminating NUL (0 byte). Returns TRUE (1) if successful, FALSE (0) if there are no more. TWAIN_NextSourceName returns the next source name as a string. This function is not available in some languages. If there is no next source name, this function returns the empty string.

TWAIN_GetDefaultSourceName TWAIN_DefaultSourceName
int TWAIN_GetDefaultSourceName(LPSTR pzName) Page 35

EZTwain Pro User Guide

char* TWAIN_DefaultSourceName() TWAIN_GetDefaultSourceName copies the name of the TWAIN default source into pzName. Up to 32 ANSI characters plus a terminating NUL (0 byte) are returned. Normally returns TRUE (1) but will return FALSE (0) if: - the TWAIN Source Manager cannot be loaded & initialized or - there is no current default source (e.g. no sources are installed) TWAIN_DefaultSourceName returns the name of the TWAIN default source as a string. This function is not available in certain languages. If there is no default TWAIN source (see above) this function returns the empty string.

TWAIN_SourceName
char* TWAIN_SourceName(void)
Returns the name of the currently or last opened source, as a string. developers: Note that this is always an 8-bit ASCII string. C/C++

See TWAIN_DefaultSourceName, to obtain the name of the default TWAIN device.

TWAIN_GetSourceName
void TWAIN_GetSourceName(LPSTR pzName)
Like TWAIN_SourceName, but copies the name string into its argument. Please allocate enough space: 64 char at least.

Page 36

EZTwain Pro User Guide

Functions Extended Image Information

Extended Image Information was introduced in TWAIN 1.7 It provides a way for a scanner to offer advanced image processing services, and send the results to a receptive application with each scanned image. For example, some higher-end scanners can detect barcode symbols or automatically deskew pages. Using this feature, an application can find out what barcodes were found on each incoming page, and the amount of skew that was corrected. The EZTwain model of this feature is fairly simple. As part of configuring for a scan, the application uses TWAIN_EnableExtendedInfo to specify which type of extended information should be collected. Each type of information is represented by a numeric constant defined in the TWAIN standard, such as TWEI_BARCODETEXT or TWEI_SKEWORIGINALANGLE. After an image is received, using TWAIN_Acquire for example, we provide functions to count and read the collected information. We have included the necessary TWEI_ constants in our declaration files, but for explanation and details you should contact us (www.dosadi.com) or visit the TWAIN website (www.twain.org) to obtain a copy of the TWAIN Standard.

TWAIN_IsExtendedInfoSupported
BOOL TWAIN_IsExtendedInfoSupported()
Asks the currently open device if it can generate Extended Image Info. Returns TRUE(1) if yes, FALSE(0) if not. This will fail and record an error if no TWAIN device is currently open through EZTwain.

TWAIN_EnableExtendedInfo
BOOL TWAIN_EnableExtendedInfo(long eiCode, BOOL enabled)
Enable or disable collection of the specified kind of extended image info. Each type of information is represented by an integer constant with prefix TWEI_ see the EZTwain declaration file for your language. This function returns TRUE.

TWAIN_IsExtendedInfoEnable
BOOL TWAIN_IsExtendedInfoEnabled(long eiCode)
Return TRUE(1) if the specified extended image info is enabled.

TWAIN_DisableExtendedInfo
void TWAIN_DisableExtendedInfo()
Disables all extended image info calling this function stops collection of extended image information.

Page 37

EZTwain Pro User Guide

Reading Extended Information

You can think of the extended image information as returning an array of 0 or more values for each enabled TWEI_ code. TWAIN_ExtendedInfoItemCount tells you how many values were returned for a given TWEI_ code. When you ask for a value, you always have to specify both the TWEI_ code and a value index. The value index is overkill in almost all cases: You will commonly specify an index of 0, meaning the first available value. Remember: All of these functions refer to information collected from the last scan.

TWAIN_ExtendedInfoItemCount
long TWAIN_ExtendedInfoItemCount(long tweiCode)
The number of values available of the given info (TWEI_) type.

TWAIN_ExtendedInfoItemType
long TWAIN_ExtendedInfoItemType(long tweiCode)
Returns a number indicating the type of data returned for the specified extended info, using the same TWTY_ codes as CONTAINER_ItemType (see page 156).

TWAIN_ExtendedInfoInt
long TWAIN_ExtendedInfoInt(long tweiCode, long n)
Returns the (32-bit integer) value of the 'nth' item of the specified extended info.

TWAIN_ExtendedInfoFloat
double TWAIN_ExtendedInfoFloat(long tweiCode, long n)
Returns the (floating point) value of the 'nth' item of the specified extended info.

TWAIN_GetExtendedInfoString
BOOL TWAIN_GetExtendedInfoString(long tweiCode, long n, LPSTR Buffer, long Bufsize)
Read the string value of the nth item of the specified info into Buffer, which has been allocated by the caller to hold Bufsize characters. Note that the value returned is ASCII (byte) text, not unicode, and always includes an ending 0 byte, even if it must be truncated to fit. Returns TRUE if the data was retrieved and could fit in the buffer, FALSE otherwise. In all languages, the caller must ensure that the 3rd parameter (Buffer) has been allocated as a block of characters (bytes) and that the address of the first byte of the allocated buffer is passed to the function. In classic VB for example, this requires

Page 38

EZTwain Pro User Guide

passing the first buffer element by reference. Contact Dosadi Support if you have questions about this.

TWAIN_ExtendedInfoString
string TWAIN_ExtendedInfoString(long tweiCode, long n)
As above, but the string is returned as a temporary pointer to a 0-terminated ASCII string. In case of any failure, returns the empty string (""). If your programming language has strings that are natively UNICODE, this function, if available at all, will return a native string and the comments above about ASCII/byte text do not apply: The string is converted to native format when it is returned from the function.

TWAIN_GetExtendedInfoFrame
BOOL TWAIN_GetExtendedInfoFrame( long tweiCode, long n, double *L, double *T, double *R, double *B)
Fetch the TW_FRAME value of the 'nth' item of the specified extended info. A frame is a TWAIN concept usually used to represent a rectangle left, top, right, bottom. This is rarely used, but is here for completeness.

Page 39

EZTwain Pro User Guide

Functions DIBs & Image Processing

DIB_Width
int DIB_Width (HANDLE hdib)
Width of DIB, in pixels (columns)

DIB_Height
int DIB_Height (HANDLE hdib)
Height of DIB, in lines (rows)

DIB_Depth
int DIB_Depth (HANDLE hdib)
Depth of DIB, in bits i.e. bits per pixel.

DIB_PixelType
int DIB_PixelType(HANDLE hdib)
Analyzes the DIB and returns a pixel type code that describes the format of the DIBs pixels: EZTwain Pixel Types Symbol TWPT_BW TWPT_GRAY TWPT_RGB TWPT_PALETTE TWPT_CMY TWPT_CMYK Code 0 1 2 3 4 5 Description 1-bit per pixel, black and white grayscale, normally 8 but can be 4- or 16-bit RGB color, 24-bit (can also be 48-bit, and rarely 15, 16, or 32-bit) indexed color (image has a color table) 8 or 4-bit. CMY color, 24-bit CMYK color, 32-bit

DIB_XResolution
double DIB_XResolution(HANDLE hdib)
Horizontal (x) resolution of DIB, in DPI (dots per inch)

DIB_YResolution
double DIB_YResolution (HANDLE hdib)
Vertical (y) resolution of DIB, in DPI (dots per inch)

Page 40

EZTwain Pro User Guide

DIB_SetResolution/DIB_SetResolutionInt
void DIB_SetResolution(HANDLE hdib, double xdpi, double ydpi) void DIB_SetResolutionInt(HANDLE hdib, int xdpi, int ydpi)
Sets the horizontal or vertical resolution of the DIB. The Int form is for languages that cannot easily pass double (64-bit floating point) parameters.

DIB_PhysicalWidth / DIB_PhysicalHeight
double DIB_PhysicalWidth(HDIB hdib, int nUnits) double DIB_PhysicalHeight(HDIB hdib, int nUnits)
Return the width(height), in the specified units, of the given image, calculated using its pixel width(height) and X(Y) resolution. If the resolution is 0, these functions return 0. nUnits is one of the TWUN_ values - see page 112 - 0=inches, 1=cm, etc.

DIB_Allocate
HANDLE DIB_Allocate(int nDepth, int nWidth, int nHeight)
Create a DIB with the given dimensions. Resolution is set to 0. A default grayscale table is provided if depth <= 8. The image data is uninitialized i.e. garbage.

DIB_Create
HANDLE DIB_Create(int nType, int nWidth, int nHeight, int nDepth)
Create a DIB with the given pixel type, dimensions, and depth. See Pixel Types, page 40. If a depth of 0 is given, the default depth for the given pixel type is used. Resolution is set to 0. If the pixel type calls for a color table (TWPT_BW, TWPT_GRAY, or TWPT_PALETTE) a default color table is provided. The image data is uninitialized.

DIB_Copy
HANDLE DIB_Copy(HANDLE hdib)
Create and return a byte-for-byte copy of a DIB.

DIB_Free
void DIB_Free(HANDLE hdib)
Release the storage of the DIB.

DIB_RowBytes
size_t DIB_RowBytes(HANDLE hdib)
Number of bytes needed to store one row of the DIB.

Page 41

EZTwain Pro User Guide

DIB_ReadRow DIB_ReadRowRGB DIB_ReadRowGray DIB_ReadRowChannel

void void void void DIB_ReadRow(HANDLE hdib, int r, BYTE* prow) DIB_ReadRowRGB(HANDLE hdib, int r, BYTE* prow) DIB_ReadRowGray(HANDLE hdib, int r, BYTE *prow) DIB_ReadRowChannel(HANDLE hdib, int r, BYTE *prow, int c)

Read row r of the given DIB into buffer at prow. Row 0 is the top row of the image, as it would be displayed. DIB_ReadRow reads the raw row data from the DIB, including BGR pixels from 24-bit DIBs, 1-bit, 4-bit or 8-bit, 16-bit, or even 48-bit pixels. DIB_ReadRowRGB converts each pixel into the nearest equivalent 3-byte RGB pixel. DIB_ReadRowGray converts every pixel to an 8-bit grayscale or brightness value. DIB_ReadRowChannel extracts the 8-bit channel or component of each pixel, as described in Component Codes, page 60 The caller is responsible for making sure there is enough room in the buffer (pointed to or referenced by the prow parameter.) Buffer sizes required are as follows: Function DIB_ReadRow DIB_ReadRowRGB DIB_ReadRowGray DIB_ReadRowChannel Bytes of buffer per row DIB_RowBytes(hdib) 3*DIB_Width(hdib) DIB_Width(hdib) DIB_Width(hdib)

DIB_WriteRow
void DIB_WriteRow(HANDLE hdib, int r, const BYTE* pdata)
Write data from buffer into row r of the given DIB. Caller is responsible for ensuring that the buffer and row exist, etc.

DIB_WriteRowChannel
void DIB_WriteRowChannel(HANDLE hdib, int r, const BYTE* pdata, int nChannel)
Write data from buffer into one color channel of row r of the given image. When writing a 24-bit RGB image, valid channels are: 1=Red, 2=Green, 3=Blue. When writing to a 32-bit RGBA image, channel 4=alpha. When writing to an 8-bit gray image, channel 0 = gray. When writing to a 24-bit CMY or 32-bit CMYK image, 1=Cyan, 2=Magenta, 3=Yellow, 4=blacK. This function should not be used on any other image format.

Page 42

EZTwain Pro User Guide

DIB_Equal
BOOL DIB_Equal(HANDLE hdib1, HANDLE hdib2)
Return TRUE (1) if the two DIBs are valid, have the same parameters, and are the same color pixel-for-pixel.

DIB_ColorCount
int DIB_ColorCount(HANDLE hdib)
Number of colors in color table of DIB.

DIB_SetGrayColorTable
void DIB_SetGrayColorTable(HANDLE hdib)
Fill the DIB's color table with a gray ramp - so color 0 is black, and the last color (largest pixel value) is white. No effect if depth > 8. The DIB must already have a color table allocated.

DIB_SetColorTableRGB
void DIB_SetColorTableRGB(HANDLE hdib, int i, int R, int G, int B)
Set the ith entry in the DIB's color table to the specified color. R G and B range from 0 to 255.

DIB_ColorTableR / DIB_ColorTableG / DIB_ColorTableB

int DIB_ColorTableR(HANDLE hdib, int i) int DIB_ColorTableG(HANDLE hdib, int i) int DIB_ColorTableB(HANDLE hdib, int i)
Return the R,G, or B component of the ith color table entry of a DIB. If i < 0 or >= DIB_ColorCount(hdib), returns 0.

Page 43

EZTwain Pro User Guide

DIB_DrawOnWindow
void DIB_DrawOnWindow(HANDLE hdib, HWND hwnd)
Draws the DIB on the window. The image is scaled to just fit inside the (client area of the) window, while keeping the correct aspect ratio. Any part of the window not covered by the image is left untouched, so will normally be filled with the windows background color.

DIB_DrawToDC
void DIB_DrawToDC( HANDLE hdib, // HDC hDC, // int dx, int dy,// int w, int h, // int sx, int sy // ) DIB handle destination device context destination (x,y) width and height source (x,y) in DIB

Draws the DIB on the device context. You should call CreateDibPalette, select that palette into the DC, and do a RealizePalette(hDC) first. Before using this call, you should have some understanding of the Windows GDI and Device Contexts.

Page 44

EZTwain Pro User Guide

Converting between DIB and other image formats

Microsoft, never content to offer one solution when it can offer two or more, has over the years created at least five widely-used classes of image object: 1. The Device-Independent Bitmap or DIB. EZTwain Pro uses this format internally, representing each image as a global handle to a block of memory containing a DIB header immediately followed by the pixel data. DIBs can store a wide variety of image formats, and retain resolution (DPI) information. In native Win32 programming, the DIB is the standard general-purpose image format, although it is usually referenced using pointers rather than a global handle. 2. The Device-Dependent Bitmap, DDB, or HBITMAP. Often simply called a bitmap, and referenced in the Win32 API by a handle called an HBITMAP, a DDB has a device-dependent pixel format (although actually the 1-bit format is standardized) and can only be manipulated by the video device driver that created it. DDBs do not store resolution (DPI) information. It is not generally meaningful to save a DDB to a file. Today, DDBs are only useful in two contexts: They are still the easiest way to embed fixed graphics as resources into a Windows program in C/C++. And if you need the absolute maximum speed, they are probably the fastest way to move pixels to and from the display. EZTwain can convert from DDB (HBITMAP) to DIB with DIB_FromBitmap. 3. The DibSection This is a strange hybrid object, an HBITMAP that wraps a DIB. Many languages and imaging classes (such as GDI+, .NET Image, Delphi TBitmap) do not easily accept DIBs but readily accept a DIBSection as an HBITMAP. EZTwain can convert a DIB to a DibSection with DIB_ToDibSection. Use this function when you need an HBITMAP. Note: DIB_ToDibSection frees the DIB. 4. The Picture/IPicture/OLE Picture object. This is a COM object wrapper for an image - it can wrap either a bitmap or a Windows Metafile (WMF). VB supports this format as the Picture type - when calling EZTwain from VB, you can use DIB_ToPicture and DIB_FromPicture. 5. The Image class The .NET framework introduced the Image class. When using EZTwain from VB.NET, you can use the function DIB_ToImage.

Page 45

EZTwain Pro User Guide

DIB_ToDibSection
HBITMAP DIB_ToDibSection(HANDLE hdib)
Convert the given DIB into a kind of bitmap called a DIBSection, which is a special kind of Windows native bitmap. The returned HBITMAP (bitmap handle) can be used with many Windows functions and controls. Many class libraries (such as .NET Image and Delphi TBitmap) also prefer this kind of bitmap. Note: The input DIB is freed and can no longer be accessed or used.

DIB_FromBitmap
HANDLE DIB_FromBitmap(HBITMAP hbm, HDC hdc)
Reverse of DIB_ToDibSection: Converts a device-dependent bitmap into a DIB (Device-Independent Bitmap). If successful, the input bitmap is deleted. Most programmers can pass 0 (NULL) for the HDC argument. The HDC (handle to device context) should only be used if you understand GDI programming and know that the HDC is compatible with the HBITMAP and contains useful color palette information. If the incoming HBITMAP is a DIBSection (for example from DIB_ToDibSection) the HDC is never needed and can always be 0.

DIB_ToImage/DibToImage
Function DIB_ToImage(ByVal hdib As System.IntPtr) As Image Function DibToImage(ByVal hdib As System.IntPtr) As Image
Converts a DIB into a .NET Image object and returns it. Note that with this function, the input DIB is not freed - your code must free the DIB when you are done with it.

Page 46

EZTwain Pro User Guide

Converting between DIBs and VB Pictures

Visual Basic has a type called variously a Picture, StdPicture, or IPicture which can be used alone, or in conjunction with the PictureBox control, whose Picture property holds a Picture object. EZTwain prefers to work with and store images as DIBs, so the following functions allow conversion between DIBs and VB Pictures. Warning: VBs Picture objects do not retain resolution (DPI) or we have not found the secret that makes it work. The resolution is what determines the implied physical (printed) size of an image, so if you need this information, you will have to somehow restore it when you convert from Picture to DIB. See p. 41 DIB_SetResolution. We recommend not converting Pictures back to DIBs. Note: The Picture type is replaced in .NET by the Image class, so these functions are not available in .NET languages - See DIB_ToImage. The EZTwain Developer Kit contains a non-trivial sample application called VBTwerp written for VB 5.0, which demonstrates use of these and many other EZTwain functions.

DIB_ToPicture
Picture DIB_ToPicture(HANDLE hdib)
Reformat the given DIB into a Picture. Note: This frees the input DIB it can no longer be accessed or used. A Picture object can be assigned to the Picture property of a PictureBox on a form, causing the picture to be displayed. Discussion of the PictureBox control is beyond the scope of this document see the VB documentation, and many Web resources. If you have a form frmMain containing a PictureBox named ScannedPic, this statement will scan an image and display it:

Dim hdib As Long hdib = TWAIN_AcquireNative(frmMain.hwnd, 0) If hdib <> 0 Then Set ScannedPic.Picture = DIB_ToPicture(hdib) End If

DIB_FromPicture
HANDLE DIB_FromPicture(Picture pic)
Create a DIB (Device-Independent Bitmap) from a Picture. The Picture itself is unchanged. This only works if the Picture contains a bitmap not an icon or metafile.

Page 47

EZTwain Pro User Guide

Text Annotation DIB_DrawText

void DIB_DrawText(HANDLE hdib, const char *pzText, int x, int y, int w, int h)
Draw text into the specified DIB image, inside the specified rectangle. All the coordinates are in pixels. The y-coordinate is measured down from the top, so (0,0) is the upper-left corner of the image. A width or height of -1 means as much as needed. When you first use this function, we recommend using w = h = 1. The text color, typeface, character height, rotation angle and format can be set with the functions below. The default text settings are: Normal (plain) style flush left, push to top character height: 14 pixels rotation angle: 0 degrees (horizontal) color: black font: Arial Example:

DIB_SetTextColor(255, 0, 0); DIB_SetTextFormat(EZT_TEXT_RIGHT+EZT_TEXT_BOTTOM); DIB_DrawText(hdib, Captured 2003.07.08 11:52, 0, 0,-1,-1);

This will draw the annotation in the bottom-right corner of the image in bright red.

Note: DIB_DrawText and anisotropic images

When drawing text into an image that has different DPI in X and Y, such as a digital fax file, the text height is reinterpreted as a physical height relative to the higher DPI value. In other words, if you set text height=25 and draw text into an image with 200 DPI horizontal and 96 DPI vertical, the text height is interpreted as 25/200 = 0.125 inches, and text is drawn correctly proportioned to be 0.125 in. high no matter how it is oriented. In this example, horizontal text would be drawn 25 pixels high and would print out 0.125 inches high. Text drawn sideways (angles of 90 or 270) will be drawn in the image 0.125 * 96 = 12 pixels high, which causes it to print and display at 12/96 = 0.125 inches high, the same as horizontal text.

DIB_SetTextHeight
void DIB_SetTextHeight(int nH)
Set the character height in pixels (image rows) for subsequent calls to DIB_DrawText. If you need to set the text height in physical units (inches) convert as follows: nH = round_to_nearest_integer(HeightInInches * DIB_Yresolution(hdib))

Page 48

EZTwain Pro User Guide

DIB_SetTextColor
void DIB_SetTextColor(int R, int G, int B)
Set the text color for subsequent calls to DIB_DrawText.

DIB_SetTextAngle
void DIB_SetTextAngle(int nDegrees)
Set the text orientation for subsequent calls to DIB_DrawText, in degrees of rotation clockwise from horizontal. Only multiples of 90 degrees are supported. Negative values (representing counter-clockwise rotation) are accepted.

DIB_SetTextFace
void DIB_SetTextFace(const char *pzFace)
Set the text typeface (text font) for subsequent calls to DIB_DrawText. Default is Arial. The fonts that are absolutely universal on Windows (including 95 and NT):

Arial Courier New Lucida Console MS Sans Serif Times New Roman Symbol: WingDings:
A machine that has Internet Explorer installed will have additional fonts:

Arial Black Comic Sans MS Georgia Impact Trebuchet MS Verdana

Page 49

EZTwain Pro User Guide

DIB_SetTextFormat
void DIB_SetTextFormat(int nFlags)
Sets the alignment and formatting of text for for subsequent calls to DIB_DrawText. These format attributes can be added or ORed together: SetTextFormat Flags Named Constant EZT_TEXT_NORMAL EZT_TEXT_BOLD EZT_TEXT_ITALIC EZT_TEXT_UNDERLINE EZT_TEXT_STRIKEOUT EZT_TEXT_BOTTOM EZT_TEXT_VCENTER EZT_TEXT_TOP EZT_TEXT_LEFT EZT_TEXT_CENTER EZT_TEXT_RIGHT EZT_TEXT_WRAP Value 0x0000 0x0001 0x0002 0x0004 0x0008 0x0100 0x0200 0x0000 0x0000 0x1000 0x2000 0x4000 Meaning / Effect plain text style, like this bold italic underlined strikeout Push text to bottom of rectangle Center text vertically within rectangle Float text to top of rectangle Push text to the left side of the rectangle Center text horizontally Push text to the right side of the rectangle Break lines into multiple lines if needed

Page 50

EZTwain Pro User Guide

Transformations & Drawing DIB_DrawLine

void DIB_DrawLine(HDIB hdib, // DIB to draw into int x1, int y1, // starting point int x2, int y2, // ending point int R, int G, int B) // color
Draw a straight line in an image (DIB) from the starting point to the ending point, using the nearest available match to the specified color. R, G, B are interpreted as 8-bit red/green/blue values 0..255. The coordinates are in pixels, with (0,0) being the upper-left corner of the image. If hdib is a B&W, grayscale, or palette image, the mathematically nearest representable color to (R,G,B) is used.

DIB_Fill
void DIB_Fill(HANDLE hdib, int R, int G, int B)
Fill all the pixels of the DIB with the specified color. R, G, B are interpreted as 8-bit red/green/blue values 0..255. If hdib is a B&W, grayscale, or palette image, the mathematically nearest representable color to (R,G,B) is used.

DIB_Negate
void DIB_Negate(HANDLE hdib)
Negates all the pixels in the DIB. Note that the color table if any is left untouched this call will not have the desired effect on an indexed-color image.

DIB_AdjustBC
void DIB_AdjustBC(HDIB hdib, int nB, int nC)
Adjust the brightness and/or contrast of the image. nB and nC are -1000 to 1000, with a value of 0 meaning 'no change'. Positive nB pushes all pixels toward white, negative toward black. Positive nC pushes all pixels away from mid-value, toward black and white. Negative nC pushes all pixels toward the mid-value. Works on grayscale, RGB, CMY(K) images - no effect on B&W and palette.

DIB_FlipVertical
void DIB_FlipVertical(HANDLE hdib)
Flips the image in the y-direction turns it upside down.

DIB_FlipHorizontal
void DIB_FlipHorizontal(HANDLE hdib)
Flips the image in the x-direction mirror-images it.

Page 51

EZTwain Pro User Guide

DIB_Rotate180
void DIB_Rotate180(HANDLE hdib)
Turns the image 180.

DIB_Rotate90
HANDLE DIB_Rotate90(HANDLE hOld, int nSteps)
Return a copy of hOld rotated clockwise nSteps * 90. If nSteps is 0, the result is a copy of hOld. Negative values of nSteps rotate counterclockwise. Note that hOld is not destroyed so you need to DIB_Free it if you are done with it.

Page 52

EZTwain Pro User Guide

Scaling, Resampling & Format Conversion DIB_ScaledCopy

HANDLE DIB_ScaledCopy(HANDLE hOld, int w, int h)
Create and return a copy of hOld scaled (resampled) to have width w and height h. This only works on 24-bit color and 8-bit grayscale images, other input will cause the function to fail and return NULL. Don't forget to DIB_Free the old DIB when you are done with it. This operation is sometimes called resampling because you have the same image, but with a different number of samples of its color values.

DIB_Resample
HDIB DIB_Resample(HDIB hOld, double xdpi, double ydpi)
Return a new image that is a copy of the old image, but resampled to the specified resolution. Resampling is the technical term for recomputing the pixels of an image, when you want to change the number of pixels in the image but not the physical size (like 8.5" x 11"). If you resample from 300DPI to 100DPI, you will have 1/3 as many rows, 1/3 as many columns, 1/9 as many pixels - but the pixels will be marked in the image as being 3 times as 'wide' and 'tall' - so the physical size of the image stays the same. This is the same as DIB_ScaledCopy (above), just looked at in a different way. DIB_Resample will fail if the input image has either resolution <= 0, or if xdpi or ydpi is <= 0. It can also fail from insufficient memory. Remember to DIB_Free the old DIB when you are done with it.

DIB_Thumbnail
HANDLE DIB_Thumbnail(HANDLE hdib, int MaxWidth, int MaxHeight)
Return an image (Dib) containing a copy of hdib, scaled so that its width is no more than MaxWidth, and height is no more than MaxHeight. Can accept any image produced by EZTwain. B&W images are converted to grayscale thumbnails. Remember to DIB_Free the original image and the thumbnail, when you are done using them.

DIB_SimpleThreshold
HDIB DIB_SimpleThreshold(HDIB hdib, int nT)
Returns a B&W copy of the given image using the given threshold. The gray value (0..255) of each input pixel is calculated: If the value < nT that pixel is black (0) in the returned image, if the value >= nT the pixel becomes white in the returned image. Remember to DIB_Free each image when you are done using it.

DIB_SmartThreshold
HDIB DIB_SmartThreshold(HDIB hdib)

Page 53

EZTwain Pro User Guide

Returns a B&W copy of the given image, using a smart thresholding algorithm. This function examines the entire image and chooses a threshold value that is optimal in some sense, for text and line-art. Remember to DIB_Free each image when you are done using it.

DIB_ConvertToPixelType
HANDLE DIB_ConvertToPixelType(HANDLE hdib, int nPT)
Takes a DIB handle and a pixel-type code (see Pixel Types, p 2) and returns a copy of the input DIB, converted into the specified pixel type. The input DIB is not affected, and must be freed with DIB_Free when no longer needed. This function can be used to expand B&W images into grayscale, to convert between RGB and CMY or CMYK formats, to convert color scans to grayscale, grayscale to B&W, and so forth. When converting to B&W, the image is thresholded using a smart threshold - see DIB_SmartThreshold above. When converting a color image to TWPT_PALETTE, an optimized color table is computed, and the image is rendered into that set of colors with a random dither technically known as error diffusion.

DIB_ConvertToFormat
HANDLE DIB_ConvertToFormat(HDIB hOld, int nPT, int nBPP)
Create and return a new DIB containing the hOld image converted to the specified pixel type and bits per pixel. Similar DIB_ConvertToPixelType but allows for nonstandard depth in the output, such as 4-bit/pixel grayscale, or 16-bit/sample RGB. Unsupported and impossible combinations cause a NULL return.

DIB_ScaleToGray
HANDLE DIB_ScaleToGray(HDIB hdibOld, int r)
Create and return a new grayscale DIB by averaging each r x r pixel square of hdibOld to create each output pixel. The output image has 1/r times the width and height, and resolution, of the input image. Works well to convert B&W images to lower-resolution grayscale images, which are not as crisp but are smoother, look better when scaled, and can be JPEG-compressed.

Page 54

EZTwain Pro User Guide

Block Copy and Masking DIB_RegionCopy

HANDLE DIB_RegionCopy(HANDLE hOld, int x, int y, int w, int h, int fill)
Create and return a new DIB that is a copy of a rectangular region of hOld. The copied region is w pixels wide, h pixels high, starting at (x, y) in the hOld image, where (0,0) is the upper-left corner of hOld, visually. Pixels that don't fit into the new DIB are discarded. If the new DIB is taller or wider than the old, the new pixels on the right and bottom are filled with bytes = fill. Common values for fill are: -1 (or 255 or 0xFF) fills with 1's producing white 0 which produces black fill. This function is useful for cropping or extending an image.

DIB_Blt
void DIB_Blt( HANDLE hdibDst, int dx, int dy, HANDLE hdibSrc, int sx, int sy, int w, int h, unsigned uRop) // // // // // // DIB destination destination (x,y) DIB source where to start in source width and height operation to apply

Copy pixels from hdibSrc into hdibDst, starting at (dx,dy) in the destination, and (sx,sy) in the source, and transferring a rectangular region w columns by h rows. Any pixels that fall outside the actual bounds of the source and destination DIBs are ignored. Put another way, the coordinates and sizes are clipped to boundaries of the actual DIBs. The operations available are: EZT_ROP_COPY 0 EZT_ROP_OR 1 EZT_ROP_AND 2 EZT_ROP_XOR 3

DIB_BltMask
void DIB_BltMask( HANDLE hdibDst, // DIB destination int dx, int dy, // destination (x,y) HANDLE hdibSrc, // DIB source int sx, int sy, // where to start in source int w, int h, // width and height unsigned uRop, // operation to apply (see note below) HANDLE hdibMask) // the mask
Like DIB_Blt, but hdibMask contains an 8-bit mask. hdibMask must be the same size as hdibSrc, and must be 8-bits per pixel. For each pixel of the affected region, if D is the destination pixel, S is the source, and M is the mask: D = (M / 255) * S + (1 M / 255) * D

Page 55

EZTwain Pro User Guide

So a mask value of 255 (usually white) causes the source pixel to replace the old destination value, a mask value of 0 leaves the destination value unchanged, and in between the source and destination are blended according to the mask value. Note: Currently only EZT_ROP_COPY is supported for the uRop parameter.

DIB_PaintMask
void DIB_PaintMask( HANDLE hdibDst, // DIB destination int dx, int dy, // starting destination (x,y) int R, int G, int B, // color to paint with int sx, int sy, // starting mask (x,y) int w, int h, // width and height unsigned uRop, // operation to apply (see note below) HANDLE hdibMask) // the mask
Like DIB_BltMask, but applies a solid color. hdibMask must be 8-bits deep. For each pixel of the affected region, if D is the destination pixel value, P is the paint color, and M is the mask: D = (M / 255) * P + (1 M / 255) * D A destination pixel D is only affected if it exists in hdibDst, falls within the rectangle specified by (dx, dy, w, h), and if the corresponding mask pixel exists in hdibMask. A width value (w) of 1 is interpreted as as wide as possible, similarly for height (h). If you paint into a grayscale DIB, the paint color is converted to a gray value if necessary. If you paint into a B&W DIB, the paint color is converted to gray, then to whichever is closest: black, or white. Note: Currently only EZT_ROP_COPY is supported for the uRop parameter.

Page 56

EZTwain Pro User Guide

Working with a DIB through a DC DIB_OpenInDC

int DIB_OpenInDC(HANDLE hdib, HDC hdc)
Create a temporary copy of the DIB and select it into the specified DC (Device Context). Allows use of any Win32 GDI function to draw through the DC into the image. The drawing actually takes place in a temporary bitmap called a DIBSection, the result are only copied back into your hdib when you call DIB_CloseInDC see below. Only one DIB can be open this way at a time: You cannot nest DIB_OpenInDC. A second call to DIB_OpenInDC without an intervening DIB_CloseInDC will display an error message and return 4. Return values: 0 -1 -2 -3 -4 Success Could not lock the hdib probably not a valid handle CreateDIBSection failed: hdc is invalid, hdib is not a DIB handle, or insufficient memory. Unable to select the DIBSection into the hdc (Unknown cause) Nested call two calls to OpenInDC without a call to CloseInDC.

DIB_CloseInDC
void DIB_CloseInDC(HANDLE hdib, HDC hdc)
Call this function exactly once for each call to DIB_OpenInDC. It has no effect at any other time. Copies the image from the DC back into the DIB and detaches it from the DC. Example: // This draws a disc of reversed color in the upper-left corner of the // image (hdib), using the GDI Ellipse function in exclusive-OR mode. HDC hdc = CreateCompatibleDC(NULL); if (hdc) { if (0==DIB_OpenInDC(hdib, hdc)) { SetROP2(hdc, R2_XORPEN); // set exclusive-or mode Ellipse(hdc, 4, 4, 132, 132); // Draw a filled circle DIB_CloseInDC(hdib, hdc); } DeleteDC(hdc); }

Page 57

EZTwain Pro User Guide

Automatic Image Improvement DIB_AutoCrop

HANDLE DIB_AutoCrop(HDIB hOld, int nOptions)
Return a copy of the image in hOld, with the surrounding border of uniform color (if there is one) cropped off. Of course this will normally change the dimensions of the image - the pixel type and depth are not changed. After this call, remember to DIB_Free(hOld) if you don't need it. nOptions is currently unused and must be 0 (zero).

DIB_GetCropRect
BOOL DIB_GetCropRect(HDIB hdib, int nOptions, int *x, int *y, int *w, int *h)
Returns a suggested crop rectangle to remove blank or unused border from the image. The returned rectangle is defined by an upper-left point and a width and height, in pixels. (Precisely the arguments needed by DIB_RegionCopy.) As usual, y and h are measured down from the top of the image. nOptions is currently unused and must be 0. DIB_AutoCrop uses this function to decide what to crop. A return of FALSE means no crop rectangle was found - generally this means that the image has content that extends to the edges, or has no definite borders of dark color. For convenience, when this function returns FALSE it sets x, y, w and h to specify the entire image.

DIB_AutoDeskew
HANDLE DIB_AutoDeskew(HANDLE hOld, int nOptions)
Returns a copy of the image in hOld, possibly 'deskewed'. If it can be determined that the input image is consistently skewed (rotated by a small angle) then the returned image is rotated to eliminate that skew. After this call, remember to DIB_Free(hOld) if you don't need it. The depth and pixel type of the image are not changed. The dimensions of the returned image may be slightly changed. nOptions is currently unused and must be 0 (zero).

DIB_DeskewAngle
double DIB_DeskewAngle(HANDLE hdib)
Compute and return the small clockwise rotation that would best deskew (vertically align) the given image. The returned angle is in radians, which may be negative or positive. Only rotations in the range 4 are considered. A value < -9.0 means that

Page 58

EZTwain Pro User Guide

an optimal rotation could not be determined. A deskew angle in the range 0.001 can probably be ignored - the image is already nearly perfectly upright.

DIB_AutoContrast
int DIB_AutoContrast(HANDLE hdib)
Automatically adjust the brightness and contrast of an image to improve it. For bimodal images, where the original material appears to be perceptually black and white, this function will adjust the brightness and contrast to make the dominant light color into white, and the primary dark tone into black. For other images, this function evaluates whether the images is using the available tonal range, and if not attempts to adjust brightness and contrast to expand the images tonal range. DIB_AutoContrast has no effect on B&W images.

DIB_MedianFilter
void DIB_MedianFilter(HDIB hdib, int W, int H, int nStyle)
Apply a median filter to an image using an W x H neighborhood. The parameter nStyle is currently ignored, but should be 0 for future compatibility. The median filter is effective at removing speckle noise from color and grayscale images, because it smooths out pixels that differ radically in value from their neighbors.

Page 59

EZTwain Pro User Guide

Image Analysis DIB_IsBlank

BOOL DIB_IsBlank(HDIB hdib, double dDarkness)
Return TRUE(1) if the DIB has less than dDarkness fraction of 'dark' pixels, FALSE(0) otherwise. A typical value of dDarkness would be 0.02 which means 2% dark pixels. A page with less than 2% dark pixels is probably blank. See How To: Skip Blank Pages, p 17.

DIB_Darkness
double DIB_Darkness(HDIB hdibFull)
Returns the fraction of an image that consists of 'dark' pixels i.e. pixels that would be black if the image was converted to B&W using a smart thresholding. (See DIB_SmartThreshold p. 53 for more details.) A return of 0.0 means none, 1.0 means all. A typical office document is 0.02 (2%) to 0.32 (32%) dark pixels. This function is used by DIB_IsBlank to decide if an image is blank.

DIB_GetHistogram
void DIB_GetHistogram(HANDLE hdib, int nComp, int nHisto[256])
This function computes a histogram of the given DIB. The third parameter must be an array of 256 32-bit integers it need not be initialized, it is output-only. When DIB_GetHistogram returns, each entry nHisto[v] contains the number of pixels in hdib that have a value of v in the specified component. This function works on B&W, grayscale, RGB, and Palette images. Component/Channel Codes Symbol COMPONENT_GRAY COMPONENT_RED COMPONENT_GREEN COMPONENT_BLUE COMPONENT_SAT COMPONENT_HUE COMPONENT_LUMINANCE C 0 1 2 3 4 5 0 Description Grayscale equivalent or lightness Red component / red channel Green component Blue component Saturation (as in HSB color model) Hue (as in HSB/HSV/HSL color models) synonym for COMPONENT_GRAY

DIB_Avg/DIB_AvgRegion/DIB_AvgRow/DIB_AvgColumn
double double double double DIB_Avg(HDIB hdib, int nComp) DIB_AvgRegion(HDIB hdib,int nComp,int x,y,w,h) DIB_AvgRow(HDIB hdib, int nComp, int y) DIB_AvgColumn(HDIB hdib, int nComp, int x)

Average the values of pixels in an image, region, row or column, and return the resulting value between 0 and 255. Note that row 0 (y=0) is the visually top-most row of an image. Page 60

EZTwain Pro User Guide

Averages either intensity (brightness) or individual color channels. See component codes above, for DIB_GetHistogram. All image formats are normalized so that white = 255.0 and black = 0, even for 1-bit B&W or 16-bit grayscale or color images.

DIB_ComponentCopy
HDIB DIB_ComponentCopy(HDIB hdib, int nComponent)
Extract and return an image containing one component (channel) of the input image. See component codes under DIB_Histogram. The returned image is an 8-bit grayscale image containing the specified channel of the input image, with the same width, height, and DPI as the input image. Caution: Future versions may return a 16-bit deep image if given a 16 bit/channel input image.

Page 61

EZTwain Pro User Guide

Miscellaneous DIB_SetColorCount
void DIB_SetColorCount(HANDLE hdib, int n)

DIB_SwapRedBlue
void DIB_SwapRedBlue(HANDLE hdib)
For 24-bit DIB only, exchange R and B components of each pixel.

DIB_CreatePalette
HPALETTE DIB_CreatePalette (HANDLE hdib)
Create and return a logical palette to be used for drawing the DIB. For 1, 4, and 8-bit DIBs the palette contains the DIB color table. For 24-bit DIBs, a default halftone palette is returned.

DIB_Lock
BITMAPINFOHEADER* DIB_Lock(HANDLE hdib)
Lock the given DIB handle and return a pointer to the header structure. Technically, increments the lock count of hdib and returns its address.

DIB_Unlock
void DIB_Unlock(HANDLE hdib)
Unlock the given DIB handle (decrement the lock count.) When the number of Unlocks = the number of Locks, any pointers into the DIB should be presumed invalid.

Page 62

EZTwain Pro User Guide

Functions Clipboard
DIB_PutOnClipboard
int DIB_PutOnClipboard(HANDLE hdib)
Place the DIB on the clipboard (format CF_DIB.) Important: After this call, the clipboard owns the DIB and you do not - you should set your copy of the DIB handle to NULL (0) and attempt no further operations on that DIB. Treat this call just as you would a call to DIB_Free. Returns 1 = success, 0 = failure.

DIB_CanGetFromClipboard
BOOL DIB_CanGetFromClipboard(void)
Return 1 if there is something on the clipboard that can be delivered as a DIB (by DIB_GetFromClipboard below.) Returns 0 if not. If you are implementing paste, call this function to enable and disable the Paste command.

DIB_GetFromClipboard DIB_FromClipboard
HANDLE DIB_GetFromClipboard(void) HANDLE DIB_FromClipboard(void)
Create and return a DIB with the contents of the clipboard. Used to implement a Paste function for images. Returns NULL in case of error, or if no image on clipboard. See DIB_CanGetFromClipboard above.

Page 63

EZTwain Pro User Guide

Printing
Configuration DIB_SpecifyPrinter
int DIB_SpecifyPrinter(string pzPrinterName)
Specify the printer to be used when printing to the default printer, as in DIB_PrintNoPrompt below. In other words, this overrides the users default printer choice. Calling this function with NULL or an empty string tells EZTwain to return to using the system default printer as the default printer.

DIB_EnumeratePrinters
int DIB_EnumeratePrinters()
Enumerate the available printers and return the count of printers found. A return value < 0 indicates some serious internal error. After this call, use DIB_PrinterName or DIB_GetPrinterName (below) to get the names of the available printers. This call can take several seconds - possibly more on some versions of Windows, depending on whether there are remote printers in the list.

DIB_PrinterName / DIB_GetPrinterName
char* DIB_PrinterName(int i) int DIB_GetPrinterName(int i, LPSTR PrinterName)
Get the name of the ith available printer. DIB_PrinterName returns the name as a string. DIB_GetPrinterName copies it into the specified character array (string buffer). In most languages, you will need to allocate and/or initialize the string variable to be 256 characters.

DIB_SetPrintToFit / DIB_GetPrintToFit
void DIB_SetPrintToFit(int nYes) int DIB_GetPrintToFit()
Get or set the print-to-fit flag. When the print-to-fit flag is non-zero, EZTwain reduces the size of printed images to fit within the printer page. This only affects images that are too large to fit on the page. By default, this flag is FALSE (0)

Page 64

EZTwain Pro User Guide

Single-Page Printing DIB_Print

int DIB_Print(HANDLE hdib, string pzJobname)
Display the standard Print dialog, and if OKd by user, print the DIB on the userselected printer. By default, prints the DIB at 'physical size' - the DIB resolution values are used to convert the width and height from pixels to physical units (e.g. inches.) If the DIB has resolution values of 0, 72 DPI is assumed. However, if the print-to-fit flag is set (see DIB_SetPrintToFit above) any image too large to print on the printer page is scaled smaller until it fits. The image is always printed centered on the page. The 2nd parameter is a string that appears in the print queue; If it is NULL or the empty string, the application title is used (See TWAIN_SetAppTitle.)

DIB_PrintNoPrompt
int DIB_PrintNoPrompt(HANDLE hdib, string pzJobname)
Like DIB_Print, but does not prompt the user. The image is printed on the default printer with default print settings.

Multipage Printing from a File DIB_PrintFile (alias TWAIN_PrintFile)

int DIB_PrintFile(string file, string jobname, BOOL bNoPrompt) int TWAIN_PrintFile(string file, string jobname, BOOL bNoPrompt)
Print the specified file with the specified job name. If the filename is null or empty, the user is prompted to select a file. If the jobname is null or empty, the actual filename is used as the jobname. If bNoPrompt is non-zero (True) the job is sent to the default printer. If bNoPrompt is zero (False) the user is prompted with the standard Print dialog. Return values: 0 success -1 user cancelled Open File dialog -2 could not open/access printer -3 error reading from file -4 printing output error -10 user cancelled Print dialog

Page 65

EZTwain Pro User Guide

Multipage Printing DIBs

If you don't have your images in a file, you can construct a multipage print job using the following three functions. Just call DIB_PrintJobBegin to start a print job, call DIB_PrintPage with each image (each image will be printed on a separate page), and call DIB_PrintJobEnd when done. Try to always call DIB_PrintJobEnd, even in event of an error: Otherwise various things are left in an undesirable state.

DIB_PrintJobBegin
int DIB_PrintJobBegin(string pzJobname, BOOL bUseDefaultPrinter)
Begins a multipage print job. Jobname is the name of the print job: This appears in the print queue , and in some environments it is printed on a job-separator page ahead of the job. If Jobname is null or empty, the application title is used. (See TWAIN_SetAppTitle) If bUseDefaultPrinter is non-zero (true) the default printer is used, otherwise the user is prompted to select the printer. If a print job is open, DIB_PrintJobEnd() is called to close it. Return values: 0 success -2 could not open/access printer -4 printing output error -10 user cancelled Print dialog

DIB_PrintPage
int DIB_PrintPage(HDIB hdib)
Print a page as part of the current job. See DIB_Print for more details. Return values: 0 success -3 the DIB is null or invalid -4 printing output error -5 no print job is open

DIB_PrintJobEnd
int DIB_PrintJobEnd(void)
End the current print job and release it for printing. (Some environments will start printing as soon as the first page is available.) Return values: 0 success -4 printing output error -5 no print job is open

Page 66

EZTwain Pro User Guide

Functions Barcode Recognition

Introduction
EZTwain barcode recognition is based on a multi-engine architecture with a specific set of supported engines in each release. You can enumerate the supported or available engines, select an engine, and use that engine to search scanned or loaded images for barcodes. Some barcode jargon you may encounter: A symbology is a style of barcode, such as Code 128, defined by a set of rules for bar widths, heights, clearance, character encoding, and error detection/correction. A symbol is what the rest of the world calls 'a barcode'. This can be confusing in barcode talk, a symbol is an entire barcode. Also called a patch, although that tends to be used more for 2D barcodes. The general paradigm for analyzing barcodes in a scanned or loaded image is this: 1. To enumerate the defined engines, call BARCODE_EngineName(i) for i = 1, 2, ... until it returns the empty string. 2. Select the desired engine using BARCODE_SelectEngine. Note also BARCODE_IsEngineAvailable. 3. Select the possible orientations for that should be searched for barcodes, using BARCODE_SetDirectionFlags. 4. You can use BARCODE_ReadableCodes to determine which barcode types are recognizable by the selected engine. 5. If you know the approximate location of your barcodes, you can improve speed and avoid 'false positives' (finding barcodes you don't want to find) by setting a recognition zone with BARCODE_SetZone. 6. Call BARCODE_Recognize, passing it the handle of the image to search, the maximum number of barcode patches to find, and a mask of the barcode types (symbologies) to look for. If this function finds any barcodes, it returns a positive integer = the count of symbols (barcodes) found. 7. If n barcodes were found, use BARCODE_Text, BARCODE_Type, BARCODE_GetRect, and BARCODE_GetText or BARCODE_Text to obtain details about each barcode, passing in an index from 0 to n-1. If you would like to learn more about the theory and practice of barcoding, we recommend The Bar Code Book by Roger C. Palmer (available through Amazon.com). There are also some helpful links on our website, at http://www.dosadi.com/barcode.htm

BARCODE_IsAvailable
BOOL BARCODE_IsAvailable(void)
TRUE(1) if some barcode recognition is available (the necessary components and DLLs are present and loadable). Returns FALSE(0) otherwise. For any barcode Page 67

EZTwain Pro User Guide

services to be available, the EZSymbol.dll must be present and loadable. Some developers do not include this DLL in their configuration, and in this case BARCODE_IsAvailable will return FALSE (0). The barcode manager and Dosadi built-in engine are implemented in the helper library EZSymbl.dll. EZSymbol.dll must be installed next to Eztwain3.dll i.e. In the same folder. Additional barcode engine DLLs, if any, must be placed where LoadLibrary can find them: Next to the Eztwain3.dll, in the System or System32 folders, or somewhere on the PATH.

BARCODE_IsEngineAvailable BARCODE_SelectEngine BARCODE_SelectedEngine BARCODE_EngineName

BOOL BARCODE_IsEngineAvailable(int nEngine) BOOL BARCODE_SelectEngine(int nEngine) int BARCODE_SelectedEngine(void) string BARCODE_EngineName(int nEngine)
These four functions allow you to detect which engines are available, to select the engine to use for recognition, and to get human-readable engine names. Barcode Engine Codes Symbol EZBAR_ENGINE_NONE EZBAR_ENGINE_DOSADI EZBAR_ENGINE_AXTEL EZBAR_ENGINE_LEADTOOLS EZBAR_ENGINE_BLACKICE Code 0 1 2 3 4 Description null barcode engine - turns off recognition. Dosadi built-in Code 3-of-9 engine Axtel AX-4 engine LEADTOOLS engine (ltbar15u.dll) Black Ice engine (BiBrw1D.dll)

Note: 'engine 0' is the null engine it does nothing and recognizes no barcode types. As of EZTwain Pro version 3.10, four barcode engines (recognition modules) are supported. Contact Dosadi support ([email protected]) if you are interested in using another barcode engine. 1. Dosadi Native Barcode Engine A very limited built-in barcode engine which recognizes only horizontal and vertical 3 of 9 code. This engine is selected by default. For more advanced barcode recognition, EZTwain can detect and use the following third party barcode engines, which must be licensed from their respective vendors: 2. Axtel AX-4 Linear Barcode Engine

Page 68

EZTwain Pro User Guide

This product is no longer available from Axtel. However, if you have a copy of AXBAR32.DLL, EZTwain Pro can use it. Select EZBAR_ENGINE_AXTEL. 3. LEADTOOLS Linear 1D Symbols Engine http://www.leadtools.com/SDK/Document/Document-Addon-Barcodelinear1D.htm We have the impression that the LeadTools engine is the fastest and one of the most accurate, and it seems to handle slanted or skewed barcodes extremely well. In keeping with its superior performance, the licensing is relatively expensive and restrictive: You must license the LeadTools Raster Imaging SDK as well as the Linear 1D Barcode SDK, and purchase a barcode run-time license for each machine that will use barcode recognition. Check the website above for the latest information. The following files are required when using LeadTools barcode recognition:

Ltkrn15u.dll Ltbar15u.dll Ltdis15u.dll Ltimgcor15u.dll Ltimgutl15u.dll Ltbar415u.dll

In addition: Note: All Unicode versions of LEADTOOLS require Microsoft Unicode Layer for Windows (UNICOWS.DLL) in order to function on Windows 95/98/Me. You can obtain MSUL from: http://msdn.microsoft.com/library/default.asp?url=/library/enus/dnanchor/html/anch_mslu.asp. LEADTOOLS Requires the following Microsoft C/C++ Runtime files to be distributed in the application's PATH: Win32 Platforms: msvcr80.dll msvcp80.dll Microsoft.VC80.CRT.manifest mfc80u.dll Microsoft.VC80.MFC.manifest MFC80ENU.dll Microsoft.VC80.MFCLOC.manifest x64 Platforms: msvcr80.dll msvcp80.dll Microsoft.VC80.CRT.manifest mfc80u.dll Microsoft.VC80.MFC.manifest MFC80ENU.dll Microsoft.VC80.MFCLOC.manifest

Note:

NOTE: that the filenames are the same for Win32 and x64. However, the actual binares are different. For more information about distributing the Microsoft C/C++ runtime files, refer to: http://msdn2.microsoft.com/en-us/library/ms235291.aspx

The Microsoft C Runtime business is quite a mess, see for example: http://www.codeproject.com/cpp/vcredists_x86.asp

Page 69

EZTwain Pro User Guide

4. Black Ice 1D Barcode Engine See http://www.blackice.com/barcodeLinear1D.htm The Black Ice engine can be licensed with a one-time license fee, and seems fast when dealing with horizontal and vertical symbols (less than 6 of skew). However we experienced much slower scanning when searching for diagonal barcodes. Some customers have reported that they found the Black Ice engine a bit more accurate than the LeadTools and Axtel engines. EZTwain looks for and loads BiBrw1D.dll - check the Black Ice SDK for information about other DLLs required by BiBrw1D.dll.

BARCODE_ReadableCodes
int BARCODE_ReadableCodes(void)
Returns a mask of the barcode types (symbologies) recognized by the currently selected barcode engine. Barcode Types (Symbologies) Barcode Types (Symbologies) EZBAR_EAN_13 EZBAR_EAN_8 EZBAR_UPCA EZBAR_UPCE EZBAR_CODE_39 EZBAR_CODE_128 EZBAR_CODE_I25 EZBAR_CODA_BAR EZBAR_UCCEAN_128 EZBAR_CODE_93 EZBAR_ANY Value (hex) 0x00000001L 0x00000002L 0x00000004L 0x00000008L 0x00000010L 0x00000040L 0x00000080L 0x00000100L 0x00000200L 0x00000400L 0xFFFFFFFFL Value (decimal) 1 2 4 8 16 64 128 256 512 1024 -1

BARCODE_TypeName
String BARCODE_TypeName(int nType)
Returns a human-readable name for the specified barcode type/symbology.

Page 70

EZTwain Pro User Guide

BARCODE_SetDirectionFlags BARCODE_GetDirectionFlags BARCODE_AvailableDirectionFlags

BOOL BARCODE_SetDirectionFlags(int nDirFlags) int BARCODE_GetDirectionFlags(void) int BARCODE_AvailableDirectionFlags(void)
Define the directions the engine will scan for barcodes. The default is left-to-right. Scanning for barcodes in multiple directions will slow the recognition process. BARCODE_SetDirectionFlags will return TRUE if completely successful, FALSE if any requested direction is invalid or not supported. As a special case, setting the direction flags to -1 is interpreted as select all supported directions. Note that as of EZTwain Pro 3.10, the Dosadi barcode engine does not support recognition of diagonal (highly skewed) symbols. Barcode Direction Flags Barcode Direction Flags EZBAR_LEFT_TO_RIGHT EZBAR_RIGHT_TO_LEFT EZBAR_TOP_TO_BOTTOM EZBAR_BOTTOM_TO_TOP EZBAR_DIAGONAL Common combinations EZBAR_HORIZONTAL EZBAR_VERTICAL Value (can be ORd together) 1 2 4 8 16 3 12

BARCODE_SetZone BARCODE_NoZone
void BARCODE_SetZone(int x, int y, int w, int h) void BARCODE_NoZone()
BARCODE_SetZone restricts subsequent barcode recognition to a rectangular zone in each image. The rectangle is defined by x,y,w,h: x = pixels from left edge, y = pixels from top edge, w = width in pixels, h = height in pixels. BARCODE_NoZone restores the default condition, in which barcode recognition is performed throughout each image.

Page 71

EZTwain Pro User Guide

BARCODE_Recognize
int BARCODE_Recognize(HDIB hdib, int nMaxCount, int nType)
Find and recognize barcodes in the given image. Don't look for more than nMaxCount barcodes (-1 means 'any number'). Expect barcodes of the specified type (-1 means 'any supported type') You can add or 'or' together barcode types, to tell the recognizer to look for more than one symbology. Return values: >0 n barcodes found 0 no barcodes found -1 barcode services not available. -3 invalid or null image Not surprisingly, recognition slows down as you allow more barcodes to be found, and as you allow more symbologies to be recognized.

BARCODE_Type
int BARCODE_Type(int n)
Return the type of the nth barcode found by the last call to BARCODE_Recognize. The returned code will be one of those listed above under Barcode Types.

BARCODE_Text
string BARCODE_Text(int n)
Return the text of the nth barcode found by the last call to BARCODE_Recognize. Barcodes found by BARCODE_Recognize are numbered from 0. If there is any problem of any kind, this function returns the empty string. In some programming languages this function is not available and you must use BARCODE_GetText (below).

BARCODE_GetText
BOOL BARCODE_GetText(int n, LPSTR Text)
Get the text of the nth barcode found by the last BARCODE_Recognize. Please allow 64 characters in your text buffer. Use a smaller buffer only if you know that the barcode type is limited to shorter strings.

BARCODE_GetRect
BOOL BARCODE_GetRect(int n, double *L, double *T, double *R, double *B)
Get the rectangle around the nth barcode found by the last BARCODE_Recognize, returning the top-left and bottom-right coordinates, in pixels, in the four parameters. (0,0) is the visual top left corner of the image. Returns TRUE(1) if successful, FALSE(0) otherwise. The only likely cause of a FALSE return would be an invalid value of n, or if you are in C or C++, a null pointer parameter. Page 72

EZTwain Pro User Guide

Page 73

EZTwain Pro User Guide

Functions Optical Character Recognition (OCR)

Introduction
Caution: At the time of this writing, this feature is in BETA test. Optical Character Recognition (OCR) is the industry term for the reading of text in an image by machine. You will also sometimes see it called Intelligent Character Recognition (ICR). This is highly relevant to scanning because so much of what we scan contains text. Extracting the text on a scanned page can be useful for indexing documents, for searching them, and for automatic routing and processing. EZTwain OCR is based on a multi-engine architecture with a specific set of supported engines in each release. You can enumerate the supported or available engines, select an engine, and use that engine to recognize text in scanned or loaded images. EZTwain Pro currently supports only one OCR engine, the TOCR engine by Transym Computer Services Ltd (www.transym.com) This engine is not provided by Dosadi it must be separately licensed and installed. The TOCR engine was chosen because it was the engine most recommended by our customers for its speed and accuracy at plain text recognition. It outputs plain text no font, font-size, style or other formatting information is provided. Although this release of EZTwain Pro only supports one engine, we expect to support additional engines in the future. Please code defensively: Engine codes are constants and will never change, but the default OCR engine may change from release to release. At start-up, EZTwain Pro will select the available engine that we think will give the most satisfactory results for the greatest number of new customers. Keep in mind that in the future this may not be the Transym engine, or it could be a substantially different version of the Transym engine.

OCR_IsAvailable
BOOL OCR_IsAvailable() This function returns True (1) if any OCR services are available. This does not mean that any particular engine is available: Always check for the particular engine you prefer using OCR_IsEngineAvailable.

OCR_Version
int OCR_Version() Returns the version number of the EZTwain Pro OCR subsystem, as the usual m.nn fraction multiplied by 100. So a version 1.25 OCR subsystem will return 125. Note that this is the version of our OCR subsystem, not the version of an OCR engine.

Page 74

EZTwain Pro User Guide

OCR_IsEngineAvailable OCR_SelectEngine OCR_SelectDefaultEngine OCR_SelectedEngine OCR_EngineName

BOOL OCR_IsEngineAvailable(int nEngine) BOOL OCR_SelectEngine(int nEngine) BOOL OCR_SelectDefaultEngine() int OCR_SelectedEngine() string OCR_EngineName(int nEngine)
These functions allow you to test for availability of a specific OCR engine, to select an engine, to see what the currently selected engine is, and to retrieve the humanreadable name of any supported engine. OCR Engine Codes Symbol EZOCR_ENGINE_NONE EZOCR_ENGINE_TRANSYM Code 0 1 Description null OCR engine - turns off OCR. TOCR engine by Transym Ltd.

Using OCR_EngineName, you can enumerate the supported OCR engines, to populate a listbox for example. Just call OCR_EngineName(i) with i = 0, 1, ... until it returns an empty string.

OCR_SetEngineKey
void OCR_SetEngineKey(string key)
Passes a registration/unlock key to the selected OCR engine. For example, Transym Computer offers a reseller version of their TOCR engine. When you license this product, you receive a special version of TOCR, and a 16-digit registration number. Once the reseller version of TOCR is installed on a computer, you can use it through EZTwain by passing in the registration number with a call like this: OCR_SetEngineKey(0123-4567-89AB-CDEF)

OCR_SetLineBreak
OCR_SetLineBreak(string sEOL)
Set the character sequence to use for line breaks in OCR'd text (as returned by OCR_Text and OCR_GetText).

The default OCR line break is \n (LF or 0x0A) Other commonly used line breaks are \r (CR, 0x0D) or CRLF. Set this before doing OCR - it does not modify already recognized text.

Page 75

EZTwain Pro User Guide

OCR_RecognizeDib
int OCR_RecognizeDib(HDIB hdib)
Recognize text in the specified image, using the currently selected engine. The recognized text can be retrieved with OCR_Text or OCR_GetText, and the position information with OCR_GetCharPositions and OCR_GetCharSizes. Return codes: 0 no error, but no text found. n>0 n characters of text are available including spaces and newlines. -1 OCR services or selected engine not available. -3 the image handle is null or invalid. -5 there was an internal error or the OCR engine returned an error. In case of an error, call TWAIN_ReportLastError, TWAIN_LastErrorCode, or similar functions for more details.

OCR_RecognizeDibZone
int OCR_RecognizeDibZone(HDIB hdib, int x, int y, int w, int h)
Recognize text in the specified rectangle (zone) of the specified image, using the currently selected engine. Otherwise identical to OCR_RecognizeDib. Be sure you understand the parameters: (x,y,w,h) specify a rectangle w pixels wide, h pixels high, starting y pixels down from the top of the image and x pixels in from the left edge.

OCR_Text
string OCR_Text()
Returns the text recognized by the last call to OCR_RecognizeDib. If there is any problem, returns the empty string.

OCR_GetText
BOOL OCR_GetText(char *buffer, int buflen)
Retrieves the text recognized by the last call to OCR_RecognizeDib. It copies no more than buflen characters into buffer, including a terminating NUL (0 character) for those languages that require this. If successful, returns True (1), otherwise False (0).

OCR_TextLength
int OCR_TextLength()
Returns the number of characters in the stored OCR text. Does not include the terminating NUL, for those of you working in languages that care about that.

Page 76

EZTwain Pro User Guide

OCR_TextOrientation
Int OCR_TextOrientation()
Returns the orientation of the text found by the last OCR_RecognizeDib. The value is the number of degrees clockwise that the input image was auto-rotated before OCR was performed. Currently, the returned value is always a multiple of 90, so the only possible values are 0, 90, 180 and 270. Example: If the original was turned 90 degrees clockwise before scanning, it will be auto-rotated 90 degrees *counter-clockwise* before OCR, so in that case the value of this function will be 270.

OCR_GetCharPositions OCR_GetCharSizes
BOOL OCR_GetCharPositions(long x[], long y[]) BOOL OCR_GetCharSizes(long w[], long h[])
Retrieve the positions and sizes, respectively, of the characters recognized by the last call to OCR_RecognizeDib. Positions are in pixels relative to the top left corner of the processed image. Sizes are in pixels. It is the caller's responsibility to ensure that x, y, w, and h are arrays of long (32-bit) integers, allocated large enough to hold N entries, where N is the character count returned by OCR_TextLength or the last call to OCR_RecognizeDib. Sorry we don't have example code yet.

OCR_ClearText
void OCR_ClearText()
Clear the text and other information stored by the last OCR recognition. After this call, OCR_TextLength will return 0, and OCR_Text and OCR_GetText will return the empty string.

OCR_WritePage
BOOL OCR_WritePage(HDIB hdib)
Recognize the text in the specified image, then write the image plus the (hidden) text to the currently open PDF output file. An available OCR engine must be selected. There must be a PDF file currently open for output, opened with TWAIN_BeginMultipageFile.

OCR_WriteTextToPDF
BOOL OCR_WriteTextToPDF()
Write the text from the last OCR to the next PDF page. The output text is retained until a page is written to a PDF file, then it is placed (invisibly) on that page. Page 77

EZTwain Pro User Guide

Functions Image Files

This section... describes the options and restrictions of each file format, explains how EZTwain decides which format to use when writing a file, describes which DLLs are required to support the various file formats, lists the functions that write images to files.

File Formats - Restrictions and Options

Format BMP Image Type(BPP) Options No options. No compression. Single page/image per file. These are standard BMP formats.

BW(1), Palette(4,8), RGB(24) Gray(8)

EZTwain can read and write this format, but some other programs may interpret a BMP of this format as a palette-color image with 256 colors (which all happen to be shades of gray...) EZTwain will read and write these non-standard formats in BMP, but few other programs will read them correctly. Many options. Most accomodating file format. EZTwain can append to an existing file. Single or multiple pages/images per file. See also: TIFF Special Features, page 89

Gray(16), RGB(48), CMY(24,48), CMYK(32) TIFF

BW(1)

Default compression: CCITT Group 4 Fax, which does very well on scanned office documents. Other supported BW compressions are RLE (runlength encoding), CCITT Group 3 Fax, LZW, and Packbits. Default compression: None. Some palette images compress well with LZW. Default compression: None. JPEG compression is available, but creates compatibility problems with some older software. These deep images can be written (and read), but are always stored uncompressed.

Palette(4,8) Gray(8), RGB(24), CMY(24), CMYK(32) Gray(16), RGB(48), Page 78

EZTwain Pro User Guide

CMY(48) PDF Highly flexible format. Supports single and multipage files. EZTwain can read its own PDF files, but not most other PDFs. EZTwain can append to its own PDF files, probably some others. See also: PDF-Specific Features, 92 Always compressed with Flate compression, which is a form of LZ compression. Always compressed with JPEG compression. Degree of compression controlled by TWAIN_SetJpegQuality. Note that CMY images are not supported. Technically, EZTwain writes the JFIF file format, which is a non-progressive JPEG stream with some additional tags such as resolution. One page/image per file. Degree of compression controlled by TWAIN_SetJpegQuality. Not defined for BW or Palette images, nor for deep images of > 8 bits/channel. No options. Single image per file. Compression is always by LZW. These can be written to GIF format but they are always converted to 8-bit palette color before writing. This is suitable only for export, because it destroys so much of the information in the image. No options. Rarely used format, commonly associated with facsimile applications. Multiple pages/images allowed in a file. Can be appended to, see: TWAIN_SetFileAppendFlag. Standard compression does well on documents. No options. Single image per file. Standard compression is LZ, which does well on scanned printed or typed documents, poorly on images and photos.

BW(1), Palette(4,8) Gray(8), RGB(24), CMYK(24) JPEG Gray(8), RGB(24), CMY(24)

GIF

BW(1), Palette(4,8) RGB(24,48), CMY(24,48), CMYK(32)

DCX

BW(1)

PNG

BW(1), Palette(4,8), RGB(24)

Page 79

EZTwain Pro User Guide

File Format Codes (TWFF_* Codes) Format Name TWFF_TIFF Code 0 Extension .tif, .tiff Meaning Tagged Image File Format. Note: By default, Group4 Fax compression is used for 1-bit images, all others are uncompressed. Windows Bitmap uncompressed. Note: BMP support is built into EZTwain, so is always available. JPEG File Interchange Format 1.02 Portable Network Graphics DCX - multipage PCX fax format. Graphics Interchange Format Note: TWFF_GIF is not a TWAIN constant, TWAIN does not recognize GIF. GIF support is only provided by EZTwain. (Adobe) Portable Document Format Note: Same comment as for GIF above.

TWFF_BMP

.bmp

TWFF_JFIF TWFF_PNG TWFF_DCX TWFF_GIF

4 7 97 98

.jpg, .jpeg .png .dcx .gif

TWFF_PDF

99

.pdf

How EZTwain Chooses Output Format

If you use TWAIN_AcquireToFilename or DIB_WriteToFilename, the format of the output file is determined as follows: If the specified filename ends in .BMP, .JPG, .JPEG, .TIF, .TIFF, .PNG, .GIF, .DCX or .PDF, then the file is saved in the corresponding format. Otherwise the current Save Format is used. The Save Format is set by TWAIN_SetSaveFormat and is initially BMP. Similarly, TWAIN_AcquireMultipageFile will write PDF format if the filename ends with .PDF, TIFF format if the filename ends with .TIF, .TIFF or .MPT (Multi-Page Tiff), and DCX format if it sees a .DCX extension. If it does not recognize the file extension, it uses the current Multipage Format which is set by TWAIN_SetMultipageFormat (p 32) and is initially TIFF.

File Format Support - Optional DLLs

The EZTwain main module (Eztwain3.dll) by itself can only read and write the BMP file format. To write the other file formats, the optional EZ* DLLs must be properly installed - See EZTwain Components, page 2.

Page 80

EZTwain Pro User Guide

Important: If you use either EZTiff.dll or EZPdf.dll, you must also install EZJpeg.dll (whether or not you actually use JPEG compression.)

DIB_WriteToFilename/TWAIN_WriteToFilename
int DIB_WriteToFilename(HANDLE hdib, string pszFile) int TWAIN_WriteToFilename(HANDLE hdib, string pszFile)
Writes an image to a file. If the file string ends with a recognized extension (BMP, JPG, JPEG, TIF, TIFF, PNG, GIF, DCX or PDF), then the file is written in the implied format. Otherwise, the file is written using the current save format: See TWAIN_SetSaveFormat. Normally if the output file exists it is overwritten, but TIFF, PDF and DCX files can be appended to: See TWAIN_SetFileAppendFlag. hdib pszFile DIB handle, as returned by TWAIN_AcquireNative filename string

If pszFile is NULL or points to a null string, the user is prompted for the filename and format with a standard Windows File Save dialog. The Save dialog will only offer formats that are available and valid for the given image. Return values: 0 success -1 user cancelled File Save dialog -2 file open error (invalid path or name, or access denied) -3 image is invalid, or cannot be written in this format. -4 writing data failed, possibly output device is full

DIB_WriteToBuffer
int DIB_WriteToBuffer(HANDLE hdib, int nFormat, BYTE* pbuffer, int nbMax)
Write the image into the buffer in the format, not exceeding nbMax bytes. The return value is the actual size of the image, which may be more or less than nbMax. If the return value > nbMax, it means only part of the image was written, and the buffer needs to be bigger. If pBuffer is NULL or nbMax=0 this function only returns the required buffer size in bytes. A return value of <= 0 indicates an error, such as The image is invalid (null or invalid DIB handle) The file format is unrecognized, not supported, not installed, etc. You can't save that kind of image in that format e.g. B&W image to JPEG format. Insufficient memory for temporary data structures (or corrupted heap) Other internal failure. Call TWAIN_LastErrorCode and similar functions for more details.

DIB_WriteArrayToFilename
int DIB_WriteArrayToFilename(HDIB ahdib[], int n, string File) Write n images from array ahdib to the specified file. Page 81

EZTwain Pro User Guide

If n is 1, this is exactly equivalent to calling DIB_WriteToFilename. If n > 1, this is a shortcut for calling TWAIN_BeginMultipageFile, TWAIN_DibWritePage (for each image) TWAIN_EndMultipageFile ...with appropriate error handling, of course. Return values: 0 success -1 user cancelled File Save dialog -2 file open error (invalid path or name, or access denied) -3 a) image is invalid (null or invalid DIB handle) b) support for the save format is not available (missing DLL?) c) DIB format incompatible with save format e.g. B&W to JPEG. -4 writing data failed, possibly output device is full -5 other unspecified internal error -6 a multipage file is already open -7 multipage support is not installed.

TWAIN_BeginMultipageFile
int TWAIN_BeginMultipageFile(string pszFile) Create or open a multipage file. If pszFile is NULL(0) or points to an empty string, prompts the user for the file name, using a standard File Save dialog. If the filename ends with .TIF, .TIFF, or .MPT, a TIFF file is started. If it ends with .DCX a DCX file is started. If it ends with .PDF a PDF file is started. Otherwise the file uses the current default multipage file format (see p 32), and if no extension is present, an appropriate extension for the format is added. If the file already exists (and is writable) its content is deleted if the File Append Flag is 0, or it is appended to if the File Append Flag is non-zero. See TWAIN_SetFileAppendFlag. Return values: 0 success. -1 user was prompted for file and cancelled the File Save dialog. -2 file open error (invalid path or name, or access denied) -3 the required EZTiff.dll, EZDcx.dll or EZPdf.dll failed to load. -5 unexpected internal error -6 multipage file already open.

TWAIN_DibWritePage
int TWAIN_DibWritePage(HANDLE hdib)
Append a page (image) to the currently open multipage file. This call will fail unless it follows a successful call to TWAIN_BeginMultipageFile. Return values: 0 success.

Page 82

EZTwain Pro User Guide

-3 -4 -5 -6

the required library (EZTiff.dll, EZDcx.dll, EZPdf.dll) failed to load or invalid DIB or DIB handle, or image format not supported (e.g. 16-bit/pixel to PDF) Write error: Output device is full? unexpected internal error. multipage file not open.

TWAIN_EndMultipageFile
int TWAIN_EndMultipageFile(void)
Return values: 0 success. -3 the required EZTiff.dll, EZDcx.dll or EZPdf.dll failed to load. -4 Write error: Output device is full? -5 some internal error -6 multipage file not open

TWAIN_IsMultipageFileOpen
BOOL TWAIN_IsMultipageFileOpen()
Returns True(1) if a multipage output file is open, False(0) otherwise. Only one multipage output file can be open at a time (per process.)

TWAIN_MultipageCount
TWAIN_MultipageCount() => int
Return the number of images written to the most recently started multipage file. In other words, this returns a counter that is reset by BeginMultipageFile, and is incremented by DibWritePage. Can also be used during or after TWAIN_AcquireMultipageFile. If you might be appending to a file and want to know the total page count of the file, see DIB_GetFilePageCount/TWAIN_PagesInFile 84.

TWAIN_SetOutputPageCount
void EZTAPI TWAIN_SetOutputPageCount(int nPages)
Tell EZTwain how many pages you are about to write to a file. This is OPTIONAL: The only effect is to add PageNumber tags to TIFF files. You can use nPages=0, which means "I don't know". See Faxing with TIFF: TIFF Class F and RFC 2301, p 91.

Page 83

EZTwain Pro User Guide

DIB_LoadFromFilename (also: TWAIN_LoadFromFilename) (also: TWAIN_LoadNativeFromFilename)

HANDLE DIB_LoadFromFilename(string pszFile) HANDLE TWAIN_LoadFromFilename(string pszFile) HANDLE TWAIN_LoadNativeFromFilename(string pszFile)
Load an image from the specified file. If anything goes wrong the return value is NULL (0) - call TWAIN_LastErrorCode and related functions for details. If the file is multipage, normally the first image is loaded but see DIB_SelectPageToLoad. If pszFile is NULL or points to an empty string, the user is prompted to choose a file with a standard File Open dialog.

TWAIN_FormatOfFile
int TWAIN_FormatOfFile(string pszFile)
Return the format of the specified file. See File Format Codes (TWFF_* Codes) above. A return value < 0 means unrecognized format.

DIB_LoadFromBuffer
HANDLE DIB_LoadFromBuffer(const BYTE* pBuffer, int nBytes)
Load an image from a buffer in memory presumably formatted as an image file. Note that for multipage files, if DIB_SelectPageToLoad was called first the designated page will be loaded. Error handling is same as for DIB_LoadFromFilename above.

TWAIN_FormatOfBuffer
int TWAIN_FormatOfBuffer(const BYTE* pBuffer, int nBytes)
Like TWAIN_FormatOfFile, but examines an image file stored in a memory buffer.

DIB_GetFilePageCount/TWAIN_PagesInFile
int DIB_GetFilePageCount(string pszFile) int TWAIN_PagesInFile(string pszFile)
Return the number of pages in the specified file. The multipage formats supported are TIFF, PDF and DCX, all other recognized formats will return a page count of 1. A return value < 0 indicates an error: No such file, unreadable, unrecognized format, etc.

DIB_SelectPageToLoad
void DIB_SelectPageToLoad(int nPage)
For use when loading multipage files. Tells DIB_LoadFromFilename which page to load next, from a multipage file. Default is page 0 (first page in file). This value is reset to 0 after each call to DIB_LoadFromFilename. Example:

Page 84

EZTwain Pro User Guide

// Load all pages from file: int N = DIB_GetFilePageCount(sFilename); for (int i = 0; i < N; i++) { DIB_SelectPageToLoad(n); hdib[i] = DIB_LoadFromFilename(sFilename); }

DIB_LoadPage
HDIB DIB_LoadPage(string pszFile, int nPage)
Short for DIB_SelectPageToLoad, DIB_LoadFromFilename. Loads the specified page from the specified file. Page 0 is the first page in a file. Multiple pages are only supported in TIFF, PDF and DCX format, all other file formats have a single page (page 0). Caution: EZTwain cannot generally read PDF files generated or modified by other software.

Page 85

EZTwain Pro User Guide

TWAIN_SetFileAppendFlag/TWAIN_GetFileAppendFlag
void TWAIN_SetFileAppendFlag(int nAppend) int TWAIN_GetFileAppendFlag(void)
These functions set and query the File Append Flag. This flag controls what EZTwain does in the event of writing to a TIFF or DCX file which already exists. If the File Append Flag is non-zero and the program attempts to write to an existing TIFF or DCX file, EZTwain appends images to the existing file. Otherwise if the File Append Flag is 0 (the default case), writing a TIFF, DCX (or any other) file overwrites any previous contents of that file. Note: If there is no existing file, this flag is ignored.

TWAIN_SetJpegQuality / TWAIN_GetJpegQuality
void TWAIN_SetJpegQuality(int nQ) int TWAIN_GetJpegQuality(void)
Sets the quality of JPEG compression throughout EZTwain, including any subsequently saved JPEG/JFIF file, or JPEG compressed image in PDF and TIFF format. You can use any value from 1 to 100, although I have never heard of anybody using a value below 40 in practice. This table lists some sample values for guidance. The sample compression gives the ratio of the uncompressed to the compressed JPEG file, for a 200 DPI RGB scan of a National Geographic magazine cover. Quality 1 25 50 75 90 100 Description Lowest-quality, smallest files Low quality Moderate quality Good quality [DEFAULT] High quality Highest quality Sample Compression 150X 40X 20X 12X 6X 2.5X

You cannot directly control the size of JPEG files lower quality means smaller files, higher quality means larger, but the relationship is non-linear and depends on the content of the image being compressed. Even at quality 100 JPEG is still a lossy compression - there will still be degradation of the image, although it is very unlikely to be detectable by the human eye. Nonetheless there are subtle mathematical changes in the image, and repeated compression and recompression even at quality level 100 can lead to cumulative (visible) image degradation. PDF: By default, PDF uses JPEG compression for grayscale and RGB or CMYK color images. See PDF_SetCompression for more information. TIFF: Subject to some warnings about compatibility, TIFF files can be written with JPEG compression (See TWAIN_SetTiffCompression.

Page 86

EZTwain Pro User Guide

TWAIN_IsJpegAvailable
int TWAIN_IsJpegAvailable(void)

TWAIN_IsPngAvailable
int TWAIN_IsPngAvailable(void)

TWAIN_IsTiffAvailable
int TWAIN_IsTiffAvailable(void)

TWAIN_IsPdfAvailable
int TWAIN_IsPdfAvailable(void)

TWAIN_IsGifAvailable
int TWAIN_IsGifAvailable(void)

TWAIN_IsDcxAvailable
int TWAIN_IsDcxAvailable(void)

TWAIN_IsFormatAvailable
int TWAIN_IsFormatAvailable(int nFF)
Return TRUE (1) if the specified image file format is available i.e. the necessary EZ*.dll files can be found and loaded. Returns FALSE(0) if not.

TWAIN_FormatVersion
int TWAIN_FormatVersion(int nFF)
Returns the version number, times 100, of the module that implements the specified file format. For example, TWAIN_FormatVersion(TWFF_PDF) returns the version of the PDF module. A return value of 123 means version 1.23. If the format code is unrecognized or the file format module is not available, this function returns 0.

TWAIN_IsFileExtensionAvailable
int TWAIN_IsFileExtensionAvailable(string sExt)
This function takes a file-extension as a string and returns TRUE (1) if the corresponding file format support is available. It returns FALSE (0) if the format is not available (presumably because the required DLL or DLLs are not installed) or if it does not recognize the extension. Case does not matter, and a leading . is optional. Examples: TWAIN_IsFileExtensionAvailable(tiff) TWAIN_IsFileExtensionAvailable(.PNG)

TWAIN_FormatFromExtension
int TWAIN_FormatFromExtension(string sExt, int nFF)

Page 87

EZTwain Pro User Guide

Return the format implied by a file specification or extension. See File Format Codes (TWFF_* Codes) above. If the extension is not recognized, returns nFF. If you pass this function a filename it will parse it to find the extension. If the string contains no ., it is assumed to be an exact extension string e.g. tif. Case is ignored of course.

TWAIN_ExtensionFromFormat
string TWAIN_ExtensionFromFormat(int nFF, string sDefExt)
Return the default extension for the file format, including leading .. See File Format Codes (TWFF_* Codes) above. If nFF is not a valid format code, the string sDefExt is returned.

TWAIN_SetSaveFormat
int TWAIN_SetSaveFormat(int nFF) Specifies the default file format for subsequent calls to DIB_WriteToFilename and TWAIN_AcquireToFilename. Displays a warning message if the format is not available: See TWAIN_IsFormatAvailable This function is now rarely used. All functions that write an image file will infer the file format from the file extension. If your filenames include recognizable extensions like .tif, you do not need to call TWAIN_SetSaveFormat. Returns TRUE (1) if successful, FALSE (0) if format is invalid or not available.

TWAIN_GetSaveFormat
int TWAIN_GetSaveFormat()
Return the current default save format.

TWAIN_LastOutputFile
string TWAIN_LastOutputFile()
Return the name of the last file written by EZTwain. Useful if you pass NULL or as a filename to DIB_WriteToFilename or TWAIN_AcquireToFilename, etc. Not available in Visual Basic.

Page 88

EZTwain Pro User Guide

TIFF Special Features

TWAIN_Compression/TWAIN_GetTiffCompression
int TWAIN_SetTiffCompression(int nPT, int nComp) int TWAIN_GetTiffCompression(int nPT)
Set or get the compression mode to use when writing TIFF files. You must specify the pixel type (image type) to which this compression applies (See p. 40 for the pixel type codes.) If you are not familiar with the properties of these compression algorithms, try Google or contact Dosadi technical support: [email protected]. TIFF Compression Modes Constant Name TIFF_COMP_NONE TIFF_COMP_CCITTRLE TIFF_COMP_CCITTFAX3 TIFF_COMP_CCITTFAX4 TIFF_COMP_LZW TIFF_COMP_JPEG Value 1 2 3 4 5 7 Compression Algorithm No compression CCITT modified Huffman RLE CCITT Group 3 fax encoding1 CCITT Group 4 fax encoding LZW2,3 JPEG-in-TIFF4 Applies to all BW BW BW all RGB, GRAY

The default compression for 1-bit BW is TIFF_COMP_CCITTFAX4, and for all other image types is TIFF_COMP_NONE. Note 1: Enables TIFF Class F - see comments on page 91. Note 2:The Unisys patent on LZW compression has expired. Note 3: LZW compression works poorly on almost all scans and camera images. Note 4: JPEG-in-TIFF has compatibility issues: EZTwain writes revised TIFF 6 JPEG.

TWAIN_SetTiffStripSize/TWAIN_GetTiffStripSize
void TWAIN_SetTiffStripSize(int nBytes) int TWAIN_GetTiffStripSize(void)
By default, images in TIFF files are stored in horizontal strips with a default size of 32768 bytes (roughly). A few nonconforming TIFF Readers cannot handle images with more than one strip, or images with large strips. Use these functions to work around this. Setting the TIFF strip size to 1 causes all images to be written using 1 strip.

TWAIN_SetTiffImageDescription TWAIN_SetTiffDocumentName
void TWAIN_SetTiffImageDescription(string pszText) void TWAIN_SetTiffDocumentName(string pszText)
These functions set the value of two standard TIFF tags, ImageDescription and DocumentName. These apply only to the next TIFF file written by EZTwain, and when EZTwain finishes writing a TIFF file, it forgets (clears) these values.

Page 89

EZTwain Pro User Guide

TWAIN_SetTiffTagShort TWAIN_SetTiffTagLong TWAIN_SetTiffTagDouble TWAIN_SetTiffTagString TWAIN_SetTiffTagRational TWAIN_SetTiffTagRationalArray TWAIN_SetTiffTagBytes TWAIN_ResetTiffTags

BOOL BOOL BOOL BOOL BOOL BOOL BOOL void TWAIN_SetTiffTagShort(int tag, short sValue) TWAIN_SetTiffTagLong(int tag, long nValue) TWAIN_SetTiffTagString(int tag, const char* pzText) TWAIN_SetTiffTagDouble(int tag, double dValue) TWAIN_SetTiffTagRational(int tag, double dValue) TWAIN_SetTiffTagRationalArray(int tag, double da[], int n) TWAIN_SetTiffTagBytes(int tag, const BYTE* pdata, int nLen) TWAIN_ResetTiffTags(void)

The tag values you set with these functions will be included in each image subsequently written to TIFF until you call TWAIN_ResetTiffTags. The TIFF standard is available through this website: http://www.remotesensing.org/libtiff/document.html The specific data formats needed by each tag are documented here: http://www.remotesensing.org/libtiff/man/TIFFSetField.3tiff.html We recommend you use the Set function that corresponds to the TIFF data type of the tag, although TWAIN_SetTiffTagDouble will correctly set any standard RATIONAL, SRATIONAL, FLOAT or DOUBLE tag, and TWAIN_SetTiffTagLong will set any standard SHORT, LONG, or SLONG tag. Custom and private TIFF tags: Please reference the TIFF standard for more details on private and custom tags. The SetTiffTag functions can be used to set such tags However for such tags you must use the function of the correct type: No conversion will be performed. Example of setting TIFF tags:

// Save hdib to TIFF, with artist and bad fax lines: #define TIFFTAG_ARTIST 315 #define TIFFTAG_BADFAXLINES 326 TWAIN_SetTiffTagString(TIFFTAG_ARTIST, ABBA) TWAIN_SetTiffTagLong(TIFFTAG_BADFAXLINES, 0) DIB_WriteToFilename(hdib, c:\DancingQueen.tif) TWAIN_ResetTiffTags()

Page 90

EZTwain Pro User Guide

TWAIN_GetTiffTagAscii / TWAIN_TiffTagAscii
BOOL TWAIN_GetTiffTagAscii(string file, int page, int tag, int len, char buffer) string TWAIN_TiffTagAscii(string file, int page, int tag)
Read the value of an ASCII-string-valued TIFF tag from the specified page of the specified TIFF file. TWAIN_TiffTagAscii returns the tag value as a string, returning the empty string if anything goes wrong. TWAIN_GetTiffTagAscii copies the string into buffer, which has room for at least len characters. Usually the buffer variable mst be allocated or resized before you call this function, to reserve the space. Returns True(1) if successful, False(0) otherwise.

Faxing with TIFF: TIFF Class F and RFC 2301

There are several variations of TIFF specialized for facsimile (fax) applications. TIFF Class F is a variant of TIFF for storing faxes, which according to one source has been in common usage for many years - as of 1997. It is not an official standard. See for example: http://palimpsest.stanford.edu/bytopic/imaging/std/tiff-f.html IETF RFC 2301 - File Format for Internet Fax is a draft Internet standard: http://www.ietf.org/rfc/rfc2301.txt EZTwain Pro can write TIFF Class F files: You will need to set a few tags by hand, as demonstrated by this code fragment which writes out a DIB. Note that the image needs to be B&W (1 bit/pixel), have a width of 1728, 2048, or 2482 pixels, and have a resolution of 204 DPI horizontal and either 98 or 196 DPI vertical.

HDIB hdib = DIB_Allocate(1, 1728, 1056); DIB_SetResolution(hdib, 200, 96); // Select Group3 Fax compression for B&W TIFF: TWAIN_SetTiffCompression(TWPT_BW, TIFF_COMP_CCITTFAX3); // Set the FillOrder tag to Least Significant Bit First #define FILLORDER_LSB2MSB 2 TWAIN_SetTiffTagLong(TIFFTAG_FILLORDER, FILLORDER_LSB2MSB); // Set the option for byte aligned EOLs #define GROUP3OPT_FILLBITS 4 TWAIN_SetTiffTagLong(TIFFTAG_GROUP3OPTIONS, GROUP3OPT_FILLBITS); // Dont break images into strips: TWAIN_SetTiffStripSize(-1); // Tell EZTwain how many pages will be in the file: TWAIN_SetOutputPageCount(1); DIB_WriteToFilename(hdib, classF.tif);

Page 91

EZTwain Pro User Guide

PDF-Specific Features
PDF_SetTitle PDF_SetAuthor PDF_SetSubject PDF_SetKeywords PDF_SetCreator PDF_SetProducer
int int int int int int PDF_SetTitle(string pzText) PDF_SetAuthor(string pzText) PDF_SetSubject(string pzText) PDF_SetKeywords(string pzText) PDF_SetCreator(string pzText) PDF_SetProducer(string pzText)

These functions set the value of standard keys in the document information dictionary of the next PDF file. These apply only to the next PDF file written by EZTwain, and when EZTwain finishes writing a PDF file, it forgets (clears) these values. EZTwain defaults both Creator and Producer to Dosadi EZPdf module Vn.nn

PDF_SetCompression
BOOL PDF_SetCompression(int pt, int comp) int PDF_GetCompression(int pt)
Set or query the compression algorithm to use when images of the specified pixel type are written to PDF. Special cases: pt=-1 means all applicable pixel types. comp=-1 means default compression for the pixel type. Thus PDF_SetCompression(-1,-1) resets the compression for all pixel types to the default. For pixel types codes and definitions, see EZTwain Pixel Types, page 40. PDF Compression Choices Constant Name COMPRESSION_DEFAULT COMPRESSION_NONE COMPRESSION_FLATE COMPRESSION_JPEG Value -1 1 5 7 Compression Algorithm Default for pixel type. No compression Flate a 'zip' compression JPEG, also called DCT. Applies to all all all gray, RGB

Page 92

EZTwain Pro User Guide

PDF_SelectPageSize
BOOL PDF_SelectPageSize(int nPaper)
Designates the page size for subsequent PDF output. See Standard Paper Sizes, page 126. By default, the PDF output page size is PAPER_NONE which means when an image is written to PDF, it is placed on a page that is the same size as the image. Images of unknown size (0 DPI) or abnormally small DPI, are arbitrarily reinterpreted as being 100 DPI. If you select a standard paper size, each image subsequently written to PDF is placed on a page of that size, and the image is reduced proportionally, if necessary, to fit on the page. You can return to the default setting at any time by calling PDF_SelectPageSize with an argument of PAPER_NONE.

PDF_SelectedPageSize
int PDF_SelectedPageSize()
Returns the current page size for PDF output. See PDF_SelectPageSize above.

PDF_DrawText
PDF_DrawText(double x, double y, string text)
Draw the specified text into the next PDF page that is written, at coordinates (x,y) on the page. Normally this function is used to draw text on a page that consists of a single image, such as a scanned page. In this case, the coordinates x and y are in pixels relative to the top-left of the image.

PDF_SetTextVisible
PDF_SetTextVisible(BOOL bVisible)
Sets the visibility of the text drawn by subsequent PDF_DrawText calls.

PDF_DrawInvisibleText
PDF_DrawInvisibleText(double x, double y, string text)
Like PDF_DrawText, but always draws the text in invisible mode, i.e. as hidden text. Does not change the text visibility mode.

Page 93

EZTwain Pro User Guide

PDF/A ISO 19005

PDF/A is a file format, a proper subset of Adobe PDF 1.4, defined by international standard ISO 19005-1 in 2005. It was created to facilitate the long-term storage of digital documents. Quoting from the Introduction to that standard: The primary purpose of this part of ISO 19005 is to define a file format based on PDF, known as PDF/A, which provides a mechanism for representing electronic documents in a manner that preserves their visual appearance over time, independent of the tools and systems used for creating, storing or rendering the files. For an overview and answers to frequently asked questions about PDF/A, see: http://www.aiim.org/documents/standards/PDF-A/19005-1_FAQ.pdf As a proper subset of PDF 1.4, PDF/A files should be readable by any PDF reader which conforms to PDF 1.4 or higher. PDF/A-1 files must include:

Embedded fonts Device-independent color XMP metadata

PDF/A-1 files may not include:

Encryption LZW Compression Embedded files External content references PDF Transparency Multi-media JavaScript

The published PDF/A-1 standard may be purchased directly from ISO or from national standards bodies around the world, such as ANSI (the American National Standards Institute).

PDF_SetPDFACompliance PDF_GetPDFACompliance
BOOL PDF_SetPDFACompliance(int nLevel) int PDF_GetPDFACompliance()
Set or get the PDF/A compliance level. Level 0 is 'no particular compliance' Level 1 tells EZTwain to write PDF files that conform to ISO 19005-1 Level B.

Page 94

EZTwain Pro User Guide

PDF Encryption / PDF Passwords

Starting with release 3.30, EZTwain Pro can write and read back encrypted, password-protected PDF files, in accordance with the PDF 1.4 specification. A PDF file can be protected with a user password, an owner password, or both. In theory, a user must present one of the passwords to gain access to the contents of the file. Quoting from PDF Reference, Third Edition (PDF 1.4): A PDF document can be encrypted (PDF 1.1) to protect its contents from unauthorized access. Encryption applies to all strings and streams in the documents PDF file, but not to other object types such as integers and boolean values, which are used primarily to convey information about the documents structure rather than its content. Leaving these values unencrypted allows random access to the objects within a document, while encrypting the strings and streams protects the documents substantive contents. The encryption used by this feature, a 40-bit RC4 encryption, while not weak, is not particularly strong by current standards. For more information and technical details, please refer to the PDF Reference, or to the many sources on the web. The expected behavior of PDF reading programs (such as Acrobat Reader or Foxit Reader) is described this way in the PDF Reference: If a user attempts to open an encrypted document that has a user password, the viewer application should prompt for a password. Correctly supplying either password allows the user to open the document, decrypt it, and display it on the screen. If the document does not have a user password, no password is requested; the viewer application can simply open, decrypt, and display the document. Whether additional operations are allowed on a decrypted document depends on which password (if any) was supplied when the document was opened and on any access restrictions that were specified when the document was created: Opening the document with the correct owner password (assuming it is not the same as the user password) allows full (owner) access to the document. This unlimited access includes the ability to change the documents passwords and access permissions. Opening the document with the correct user password (or opening a document that does not have a user password) allows additional operations to be performed according to the user access permissions specified in the documents encryption dictionary. When EZTwain functions are called to read an image or other content from an encrypted PDF file, they follow the guidelines given above with one difference: EZTwain first checks to see if the application has supplied a password using the PDF_SetOpenPassword function below. If so, that password is used exactly as if the user had entered it at a password prompt. Otherwise, if the PDF has a user password, the user is prompted for a password. If the supplied password matches either the user or owner password of the document, the document is opened and the requested content is retrieved. EZTwain Pro does not and cannot enforce any access restrictions. Page 95

EZTwain Pro User Guide

PDF_SetOpenPassword
PDF_SetOpenPassword(string sPass)
Sets the password to be used to open encrypted PDF files. When EZTwain is asked to read content (usually an image) from an encrypted PDF, if the open password has been set with this function, that password is used to attempt to open the PDF, as if the user had entered it at a password prompt. If no password has been defined using this function, then the PDF read routines follow the guidelines quoted above from the PDF Reference.

PDF_SetUserPassword
PDF_SetUserPassword(string sPass)
Specify the user password for the next PDF file to be written. Setting a non-empty password for a PDF file causes that PDF to be encrypted using the standard encryption of PDF 1.4 as discussed above. When EZTwain completes writing a PDF file, this password is cleared to the empty string.

PDF_SetOwnerPassword
PDF_SetOwnerPassword(string sPass)
Define an owner password for the next output PDF file. Setting a non-empty password for a PDF file causes that file to be encrypted. When a PDF file is completed and closed, the owner password is cleared.

Page 96

EZTwain Pro User Guide

PDF_SetPermissions / PDF_GetPermissions
PDF_SetPermissions(long nPermMask) long PDF_GetPermissions()
Set or Get the access permissions mask to be written into the next output PDF file. This mask asks PDF viewer programs to restrict certain activities by the user, beyond simply opening and viewing the file.

Permissions are only written if you set a user or owner password. It is a permission mask 1 bits mean 'allow', 0 bits mean 'prevent'. Acrobat honors these restrictions, but other PDF readers may not. The permission mask you set applies only to the next PDF file written. The default permissions mask is 'allow everything' (-1) Setting a mask of 0 means 'prevent everything preventable'.

You can use bitwise operations, or +/- to combine these constants, for example, to disallow copying text and graphics from the file:'

PDF_SetPermissions(PDF_PERMIT_ALL - PDF_PERMIT_COPY)
Bit 1 2 3 4 5 6 all Value Named Constant 1 2 4 PDF_PERMIT_PRINT 8 PDF_PERMIT_MODIFY 16 32 -1 PDF_PERMIT_COPY PDF_PERMIT_ANNOTS PDF_PERMIT_ALL Operation (permitted if bit is set) (unused) (unused) printing the document making changes, other than notes & form fields copying or extracting content adding or changing comments or form fields All of the above

Page 97

EZTwain Pro User Guide

Functions File Uploading

Overview
EZTwain Pro provides some basic services for uploading one or more images to a webserver, using the HTTP POST command. The upload functions emulate the HTTP handshake produced by a web browser when a user submits a form containing a fileselection control. However using the EZTwain UPLOAD feature, no browser is required and there is no user interaction. This feature of EZTwain Pro is optional - it is implemented in the EZCurl.dll, which you may omit from your software configuration if you do not need uploading services. As its name suggests, EZCurl.dll is a custom build of the highly respected open-source libcURL library by Daniel Stenberg.

UPLOAD_IsAvailable
BOOL UPLOAD_IsAvailable()
Returns True(1) if uploading services are available, False(0) otherwise. Currently this means that the EZCurl.dll has been found and loaded successfully, see the overview comments.

UPLOAD_Version
int UPLOAD_Version()
Returns the version number of the upload services module, EZCurl.dll, as an integer: major version * 100 + minor version. For example at the time of this writing, this function returns 715 which signifies EZCurl version 7.15.

UPLOAD_MaxFiles
int UPLOAD_MaxFiles()
Returns the maximum number of files that can be uploaded in one upload operation. At the time of this writing, this function returns 999.

Page 98

EZTwain Pro User Guide

UPLOAD_AddFormField
BOOL UPLOAD_AddFormField(string name, string value)
Set a form field to a value for the next upload. The name of the field must be expected by the page/script you upload to. All fields set with this function are discarded and forgotten after the upload that uses them. This function returns True if successful, False otherwise. It can fail if more than 32 fields are defined prior to an upload, or if either argument is NULL. A successful return means only that the field was recorded, not that it was sent to or received by the server. For example, suppose you have been uploading scanned documents to your server using a web form like this:

<form name="form1" method="post" action="upload.php" enctype="multipart/form-data"> Vendor ID: <input type="text" name="vendor id"><br> File to upload: <input type="file" name="file"><br> <input type="submit" name="Submit" value="Submit"> </form>

You might replace this form with an automatic upload of a scanned document with code similar to this:

UPLOAD_AddFormField("vendor id", "1290331") UPLOAD_DibToURL(hdib, "http://dosadi.com/eztx/upload.php", "file.pdf", "file")

Page 99

EZTwain Pro User Guide

UPLOAD_DibToURL UPLOAD_DibsToURL UPLOAD_DibsSeparatelyToURL UPLOAD_FilesToURL

int UPLOAD_DibToURL(HDIB hdib, string url, string filename, string field) int UPLOAD_DibsToURL(HDIB ahdib[], int n, string url, string filename, string field) int UPLOAD_DibsSeparatelyToURL(HDIB ahdib[], int n, string url, string filename, string field) int UPLOAD_FilesToURL(string files, string url, string field)
Upload an image, a set of images, or a set of files to a script on a server, emulating a form being submitted from a browser via HTTP-POST. Parameters hdib ahdib n url filename handle to image to upload address or reference to array of image handles number of images to take from ahdib the receiving script as a URL. For example: http://www.dosadi.com/upload.php the (pretended) name of the uploaded file. This is not the name of an actual file! The images to be uploaded are collected into a temporary file, and POSTed to the server: The server is told that it is receiving a file of this name. The extension on this filename determines the format of the uploaded file: .tif for TIFF format, .jpg for JPEG format, and so on. A string containing one or more filenames, separated by semicolons (;) or vertical bars (|) e.g. c:\file1.jpg;c:\file2.tif the name of the file-upload field on the form. Some scripts require a specific field name. When multiple files are being sent to the server, the value of field is modified by appending 1, 2, etc. to it.

files field

Operation All of these functions have in common that they emulate a web browser submitting to a server a multipart form with one or more files attached. The UPLOAD_Dib... functions do not actually read or create the named files they just send the data to the server as if such a file was being uploaded. On the other hand, UPLOAD_FilesToURL expects to find the specified file or files on the local disk, and it uploads their contents and sends along their names. A call to UPLOAD_DibToURL(hdib, http:server/script, filename, field) looks to the server script as if the user had browsed to a page on server, viewed the following form, selected a local file named filename and submitted the form:

Page 100

EZTwain Pro User Guide

<form name="form1" method="post" action="script" enctype="multipart/form-data"> Upload this file: <input type="file" name="field"> <input type="submit" name="Submit" value="Submit"> </form>
UPLOAD_AddFormField can be used to insert additional fields in the upload form, UPLOAD_AddHeader can be used to 'tweak' the HTTP header of the upload, and UPLOAD_EnableProgressBar can be used to hide or suppress the progress bar that EZTwain Pro normally displays during an upload. Return values 0 success (transaction completed) Note: A success return means only that the data was sent to the server and a response was received, not that the receiving script necessarily accepted the submitted file. See DIB_UploadResponse below. -1 user cancelled File Save dialog (should never happen!) -2 could not write temp file - access denied, volume protected, etc. -3 a) image is invalid (null or invalid DIB handle) b) The DLL(s) needed to save that format failed to load c) DIB format incompatible with save format e.g. uploading a B&W image as JPEG. d) filename extension isnt one EZTwain recognizes. -4 writing data failed, maybe the disk with the temp folder is full? -5 other unspecified internal error -1xx libcurl (the library EZTwain uses) returned error code xx For example: -106 Could not resolve host -107 Couldn't connect -126 (UPLOAD_FilesToURL only) The specified files could not be opened and read. -155 Connection was aborted.

Page 101

EZTwain Pro User Guide

Server Response
These functions deal with the text returned by the server in response to an UPLOAD operation such as UPLOAD_DibToURL. EZTwain collects and stores the text returned by the server in response to the last upload, up to an implementation-defined limit, currently around 12000 bytes.

UPLOAD_ResponseLength
int UPLOAD_ResponseLength()
UPLOAD_ResponseLength returns the number of characters returned by the server to the last Upload request, up to the maximum EZTwain can store.

UPLOAD_ClearResponse
void UPLOAD_ClearResponse()
UPLOAD_ClearResponse clears the stored response text. You usually don't need to call UPLOAD_ClearResponse, all the UPLOAD functions call it when they start.

UPLOAD_Response
string UPLOAD_Response()
UPLOAD_Response returns the text received from the server/script, in response to the last upload. Assume that this string can be any length and code defensively: Use UPLOAD_ResponseLength if necessary to preallocate storage. This will be the empty string before any upload, and after an upload that returns a negative status code. If you language permits, we recommend using UPLOAD_Response rather than UPLOAD_GetResponse.

UPLOAD_GetResponse
void UPLOAD_GetResponse(string s)
UPLOAD_GetResponse copies the last upload server response into a string parameter. This text is never more than 1024 characters long - If you are using UPLOAD_GetResponse, please pre-allocate your string variable accordingly.

Page 102

EZTwain Pro User Guide

UPLOAD_AddHeader
BOOL UPLOAD_AddHeader(string header)
Add the specified line to the HTTP header of the next upload. This can be used, for example, to send a cookie or a pragma to the server. This allows you to tinker with the headers sent by EZTwain Pro.

UPLOAD_EnableProgressBar UPLOAD_IsEnabledProgressBar
UPLOAD_EnableProgressBar(BOOL bEnable) BOOL UPLOAD_IsEnabledProgressBar()
Enable or disable that is, show or hide - the progress-bar that appears during uploads. The default state of this setting is enabled (True)

Page 103

EZTwain Pro User Guide

Functions Image Viewing

TWAIN_ViewFile
int TWAIN_ViewFile(string pszFile) Opens an image viewer window and displays the specified image file in it. The window can be resized by the user. If the file contains multiple pages/images, controls are displayed for stepping between the pages. The filename is displayed as the title/caption of the window. By default, the dialog is modal with an [OK] button. The operation of this function can be modified using TWAIN_SetViewOption below. Return values: -1 error creating the window or opening/reading the file 0 user cancelled the window (by clicking the close box) 1 user clicked the OK button. Caution: EZTwain cannot generally read PDF files generated or modified by other software.

DIB_View
int DIB_View(HDIB hdib, string pzTitle, HWND hwndParent)
Display the given image in a viewer window with the given title. If hdib is 0 (NULL), the viewer window still opens but no image is displayed. hwndParent is the window handle of the parent window - if you use 0 (NULL) for this parameter, EZTwain uses the active window of the application if there is one, or no parent window. By default, the window contains only an [OK] button, the style of the window is a resizable dialog box, the dialog is modal, and this function does not return until the user closes the dialog or clicks the [OK] button. The operation of this function can be modified using DIB_SetViewOption below.

DIB_SetViewImage
BOOL DIB_SetViewImage(HDIB hdib)
If the image viewer is open, this displays the specified image in the viewer window. To use this function, first call DIB_SetViewOption(modeless, true) and then DIB_View(0, <title>, 0) This opens the image viewer window with no current image. Then you can call DIB_SetViewImage repeatedly to display images, and DIB_ViewClose when you are done.

DIB_IsViewOpen/TWAIN_IsViewOpen
BOOL DIB_IsViewOpen()

Page 104

EZTwain Pro User Guide

Returns TRUE(1) if the viewer window is open, FALSE(0) otherwise. Normally this is only possible if the viewer is operating as a modeless dialog - set DIB_SetViewOption.

DIB_ViewClose/TWAIN_ViewClose
BOOL DIB_ViewClose()
Close the image viewer window if it is open. If it is not open, do nothing.

Page 105

EZTwain Pro User Guide

DIB_SetViewOption/TWAIN_SetViewOption
BOOL DIB_SetViewOption(string option, string value)
Set the value of an option related to TWAIN_ViewFile or DIB_View. Supported options and values are listed below. Image Viewer Options2 Option modal modal Value true1,3 false 4 Effect Operate the viewer window as a modal dialog. Do not return from DIB_View or TWAIN_ViewFile until the user closes the viewer window. Operate the viewer window as a modeless dialog. When DIB_View or TWAIN_ViewFile is called, display the image in the viewer window and return immediately, leaving the viewer window open. same as modal,false - viewer is modeless. same as modal,true - viewer is modal. Set the position of the viewer window. X,y,w and h can be integers which are interpred as pixels. If a number is followed by a percent-sign (%) it is interpreted as that percent of the available screen width or height. w and h are optional. Set the left (x) coordinate of the viewer. As with position, n means pixels from the left side of the work area, n% means n% of the screen width. Set the top (y) coordinate of the viewer. Set the width of the viewer window. Set the height of the viewer window. Set the width and height of the viewer window. Show the viewer dialog, when it is modeless. Hide the viewer dialog, when it is modeless. reset to default value all options that have one. Set the title bar text of the viewer window. Show the [OK] button in the viewer. Dont show the [OK] button. Show the [Cancel] button in the viewer. Don't show the [Cancel] button. Show the [Print...] button in the viewer Don't show the [Print...] button.

modeless modeless position

true 3 false 1,4 x,y or x,y,w,h n or n% n or n% n or n% n or n% w,h true 1,3 false 4 (ignored) any string true 1,3 false 4 true 3 false 1,4 true 3 false 1,4

x or left y or top width height size visible visible reset title ok.visible ok.visible cancel.visible cancel.visible print.visible print.visible

1: Default value. 2. We show all options and values with quotes because they are strings. Your language may use another way of quoting strings. 3: In place of true you may use: 1, yes, vrai, oui, si, or ja. 4: In place of false you may use: 0, no, faux, non, or nein.

Page 106

EZTwain Pro User Guide

Functions Error Handling & Logging

TWAIN_SuppressErrorMessages
int TWAIN_SuppressErrorMessages (int nSuppress) Enable or disable EZTwain error messages to the user. Returns the previous state of the flag. When nSuppress = 0, error messages are displayed. When nSuppress <> 0, error messages are suppressed. By default, error messages are displayed. Note that EZTwain cannot prevent message boxes displayed by TWAIN or DSs.

TWAIN_ReportLastError
void TWAIN_ReportLastError(string pzMsg) Like TWAIN_ErrorBox, but if some details are available from TWAIN about the last failure, they are included in the message box. This function uses TWAIN_LastErrorText to find out about the last error see below.

TWAIN_LastErrorCode
int TWAIN_LastErrorCode(void)
Return the most recent EZTwain error code, one of the EZTEC_ codes See the EZTwain declaration file for your programming language, or refer to eztwain.h.

TWAIN_LastErrorText / TWAIN_GetLastErrorText
void TWAIN_GetLastErrorText(LPSTR pzMsg) string TWAIN_LastErrorText(void)
Returns a text string describing the last error encountered by EZTwain. In other words, this function is like TWAIN_LastErrorCode, but it translates the error into a human-readable (English) string. For example, if you try to scan from a device that is disconnected, this function may return something like: "Could not open TWAIN device: EPSON TWAIN 5\n(check power and connections.)". This string may contain end-of-line characters. The returned string will not exceed 512 (ASCII) characters long if you use TWAIN_GetLastErrorText, make sure you pre-allocate the variable to have enough room.

TWAIN_ClearError
void TWAIN_ClearError(void)
Set the EZTwain internal error code to EZTEC_NONE and clears the last error text.

TWAIN_GetResultCode
unsigned TWAIN_GetResultCode(void)
Return the result code (TWRC_xxx) from the last triplet sent to TWAIN

Page 107

EZTwain Pro User Guide

TWAIN_GetConditionCode
unsigned TWAIN_GetConditionCode(void)
Return the condition code from the last triplet sent to TWAIN. (To be precise, from the last call to TWAIN_DS) If no Source is open, return the condition code of the source manager.

TWAIN_ErrorBox
void TWAIN_ErrorBox(string pzMsg)
Post an error message box with an OK button. The string argument is used as the text of the box, and the application title (see TWAIN_RegisterApp and TWAIN_SetAppTitle) is used as the title or caption of the box. If messages are suppressed (see below) this function does nothing.

TWAIN_LogFile
void TWAIN_LogFile(int fLog)
EZTwain can write a quite detailed log of its activity, including every TWAIN call it makes and the result. Log output goes to c:\eztwain.log. You can use TWAIN_SetLogFolder to direct the log file to another directory. TWAIN_LogFile(0) TWAIN_LogFile(1) close log file and turn off logging open log file (if not already) and start logging.

If logging is already turned on, TWAIN_LogFile(1) flushes the logfile to disk so prior output wont be lost in a subsequent crash.

TWAIN_WriteToLog
void TWAIN_WriteToLog(string pzText)
Write text to the EZTwain log file, eztwain.log. If the text does not end with an endof-line character, one is added. If logging is turned off, this call has no effect. TWAIN_LogFile controls logging. TWAIN_SetLogFolder controls the location of the log file.

TWAIN_SetLogFolder
void TWAIN_SetLogFolder(string pzFolder)
Set the directory that will contain the eztwain.log file. By default this folder is the root of the C drive: c:\ Calling this function with a NULL pointer or an empty string resets the log folder to the default c:\. TWAIN_SetLogFolder(c:\ top\middle\logs) will create the logs folder if necessary, but will not create the top or middle folders. If this function is called while logging is active, the current logfile is relocated, intact, to the new folder.

Page 108

EZTwain Pro User Guide

Functions TWAIN State

To work with TWAIN, you must have some understanding of the TWAIN State. In TWAIN, a conversation with a device moves up and down a ladder of 7 distinct states. In each state, certain operations are permitted and others are invalid, and certain operations or events indicate that the conversation has moved into another state. TWAIN States State 1 2 3 4 5 6 7 EZTwain Symbolic Name TWAIN_PRESESSION TWAIN_SM_LOADED TWAIN_SM_OPEN TWAIN_SOURCE_OPEN TWAIN_SOURCE_ENABLED TWAIN_TRANSFER_READY TWAIN_TRANSFERRING Description Source Manager not loaded Source Manager loaded Source Manager open Source open for negotiation Source enabled to acquire Image ready to transfer Image in transit

EZTwain carefully tracks the TWAIN State, and hides a lot of the details of managing the state, but not all. The following group of functions are the ones concerned with directly reading and modifying the TWAIN State.

TWAIN_State
int TWAIN_State(void)
Returns the State (see above) of the TWAIN conversation.

TWAIN_LoadSourceManager
int TWAIN_LoadSourceManager(void) Finds and loads the TWAIN Source Manager. If Source Manager is already loaded, does nothing and returns TRUE(1). This can fail if twain_32.dll is not installed (in the right place), or if the library cannot load for some reason (insufficient memory?) or if twain_32.dll has been corrupted.

TWAIN_OpenSourceManager
int TWAIN_OpenSourceManager(HWND hwnd)
Opens the Source Manager, if not already open. If the Source Manager is already open, does nothing and returns TRUE. This call will fail if the Source Manager is not loaded.

TWAIN_OpenDefaultSource
int TWAIN_OpenDefaultSource(void)
This opens the source selected in the Select Source dialog. If some source is already open, does nothing and returns TRUE. Will load and open the Source Manager if needed. If this call returns TRUE, TWAIN is in State 4 (TWAIN_SOURCE_OPEN) Page 109

EZTwain Pro User Guide

TWAIN_OpenSource
int TWAIN_OpenSource(string pzName) Opens the Source with the given name. If that source is already open, does nothing and returns TRUE. If another source is open, closes it and attempts to open the specified source. Will load and open the Source Manager if needed. If this call returns TRUE, TWAIN is in State 4 (TWAIN_SOURCE_OPEN)

TWAIN_EnableSource
int TWAIN_EnableSource(HWND hwnd) Enables the open Source for image acquisition. Enabled in TWAIN parlance means that the Source has permission to begin acquiring images. Until it is enabled, a Source will never begin any image acquisition, nor will it offer an image for transfer. This call returns TRUE(1) if it leaves the Source in State 5 or higher. A return of FALSE(0) indicates that either the Enable failed, or that the Source asked to be closed immediately! If the Source is already enabled when you make this call, it does nothing and returns TRUE. By default the Source is asked to display its user interface, but this can be controlled with TWAIN_SetHideUI. If a Source is enabled without its user interface, it should if possible immediately offer to transfer an image on return from TWAIN_EnableSource, the TWAIN_State() should be 6 (Transfer Ready.) By default the parent window is not affected, but this can be changed using TWAIN_DisableParent.

TWAIN_DisableSource
int TWAIN_DisableSource(void)
Disables the open Source, if any. This closes the Source's user interface. If there is not an enabled Source, does nothing and returns TRUE.

TWAIN_CloseSource
int TWAIN_CloseSource(void)
Closes the open Source, if any. If the Source is enabled, disables it first. If there is not an open Source, does nothing and returns TRUE.

TWAIN_UnloadSourceManager
int TWAIN_UnloadSourceManager(void)
Closes and unloads the TWAIN Source Manager. If necessary, it will abort transfers, close the open Source if any, and close the Source Manager. If successful, it returns 1 (TRUE) otherwise 0 (FALSE).

Page 110

EZTwain Pro User Guide

TWAIN_EndXfer
int TWAIN_EndXfer(void)
Only valid in State 7, it signals the DS to go to either State 6 if it has more transfers ready, or to State 5 if it does not. It would be very unusual to need to call this: The Acquire functions call this after each transfer. The other state-changing functions will call this if they find themselves in State 7 and need to move down.

TWAIN_AbortAllPendingXfers
int TWAIN_AbortAllPendingXfers(void)

Page 111

EZTwain Pro User Guide

Functions Capability
TWAIN_SetXferCount
int TWAIN_SetXferCount(int nXfers)
Tell the Source the number of images the application will accept. nXfers = -1 means any number (the default, when a device is opened.) Returns: 1 for success, 0 for failure.

TWAIN_GetCurrentUnits
int TWAIN_GetCurrentUnits(void)
Return the current unit of measure: inches, cm, pixels, etc. see list below. Many TWAIN parameters such as resolution are set and returned in the current unit of measure. There is no error return - in case of error it returns 0 (TWUN_INCHES) TWAIN unit codes (from twain.h) #define TWUN_INCHES #define TWUN_CENTIMETERS #define TWUN_PICAS #define TWUN_POINTS #define TWUN_TWIPS #define TWUN_PIXELS 0 1 2 3 4 5

TWAIN_SetUnits
int TWAIN_SetUnits(int nUnits)
Set the current unit of measure for the source. Common unit codes are given above. Most sources do not support all units, some support only inches. Some cameras support only pixels. If you want to get or set resolution in DPI, make sure the current units are inches, or you might get Dots-Per-Centimeter!

TWAIN_GetPixelType
int TWAIN_GetPixelType(void)
Ask the open device for the current pixel type. See table below. If anything goes wrong (it shouldn't), this function returns 0 (TWPT_BW).

Page 112

EZTwain Pro User Guide

TWAIN_SetPixelType
int TWAIN_SetPixelType(int nPixType)
Try to set the current pixel type for acquisition. The source may select this pixel type, but don't assume it will. This function should be used in place of the older TWAIN_SetCurrentPixelType. Pixel Type Codes (TWPT_*) Code 0 1 2 3 4 5 TWAIN Name TWPT_BW TWPT_GRAY TWPT_RGB TWPT_PALETTE TWPT_CMY TWPT_CMYK Description 1-bit per pixel, black and white grayscale, 8 or 4-bit RGB color, 24-bit (rarely, 15,16,32-bit) indexed color (image has a color table) 8 or 4-bit. CMY color, 24-bit CMYK color, 32-bit

TWAIN_GetBitDepth
int TWAIN_GetBitDepth(void)
Get the current scanning bit depth, which can depend on the current PixelType. In theory, bit depth is per color channel e.g. 24-bit RGB has bit depth 8. In practice a lot of devices return 24 as the bit depth for RGB. If anything goes wrong, this function returns 0.

TWAIN_SetBitDepth
int TWAIN_SetBitDepth(int nBits)
Try to set the scanning bit depth for the current pixel type. Note: You should set a PixelType, and then set the bitdepth for that type. Tip: Some scanners advertise 12-bit scanning or 14-bit A/D. Just because this appears in the specifications does not mean the TWAIN driver supports it, but if it does, you usually use it by setting BitDepth to 16. You generally cannot use TWAIN_AcquireNative to scan 16-bit/channel images, because there is no such DIB format! The TWAIN drivers just dont know what to do. Use memory transfer [See TWAIN_AcquireMemory, p. 29] to acquire 16-bit/channel images.

TWAIN_GetCurrent Resolution
double TWAIN_GetCurrentResolution(void)
Ask the source for the current (horizontal) scanning resolution. Resolution is in dots per current unit! (See TWAIN_GetCurrentUnits above) If anything goes wrong (it shouldn't) this function returns 0.0

TWAIN_GetYResolution
double TWAIN_GetYResolution(void)
Returns the current vertical resolution, in dots per *current unit*. In the event of failure, returns 0.0. Page 113

EZTwain Pro User Guide

TWAIN_SetResolution/TWAIN_SetResolutionInt
int TWAIN_SetResolution(double dRes) int TWAIN_SetResolutionInt(int nRes)
Try to set the current resolution for scanning. This call sets both vertical (y) and horizontal (x) resolution to the same value. See TWAIN_SetXResolution below if you want to set x and y resolution separately. With scanners if this call succeeds, subsequent scans will be made at this resolution. Naturally, this will not be useful on devices that store images ahead of time, like digital cameras. And generally videocapture devices ignore or reject resolution settings. Resolution is in dots (samples) per current unit. (See TWAIN_GetCurrentUnits above) The source may select this resolution, but don't assume it will. Almost all scanners that scan paper can support 200 DPI and 300 DPI. Beyond that, the specific values vary quite widely from model to model. To query the values supported by a scanner, see Appendix 2 - Working with Containers, p 155.

TWAIN_SetXResolution / TWAIN_SetYResolution
int TWAIN_SetXResolution(double dxRes) int TWAIN_SetYResolution(double dyRes)
Be aware that many scanners will not accept different x and y resolution values they will either ignore the different y-resolution value, or they will lock the two parameters together: Setting either parameter will set both to the same value.

TWAIN_SetContrast
int TWAIN_SetContrast(double dCon)
Try to set the current contrast for acquisition. Contrast is not a required capability, do not assume a particular scanner supports it. The TWAIN standard says that the range for this cap is -1000 ... +1000.

TWAIN_SetBrightness
int TWAIN_SetBrightness(double dBri)
Try to set the current brightness for acquisition. Brightness is not a required capability, do not assume a particular scanner supports it. The standard range for this cap is -1000 ... +1000 we have seen other ranges

Page 114

EZTwain Pro User Guide

TWAIN_SetThreshold
int TWAIN_SetThreshold(double dThresh)
Try to set the threshold (TWAIN: ICAP_THRESHOLD) for black and white scanning. Legal values for threshold are 0 to 255. Returns TRUE(1) for success, FALSE(0) for failure. If a device is not open (TWAIN_State=4) this function will record an error and fail. How does Threshold work? In B&W scanning mode, you can think of the scanner as measuring each pixel of the document to get an 8-bit number (0..255) where 0 is the darkest measurable black, and 255 is the lightest white. When the scanner delivers the B&W image to your application, pixels that fall below the threshold are set to black, pixels above the threshold are set to white. Nobody can say what happens to pixels that are equal to the threshold don't worry about it! As you lower the threshold your scanned images tend to become whiter, and as you raise the threshold the scans tend to become darker. Field Notes The TWAIN default threshold value is 128, but that does not mean much: Most scanners default to a threshold of 128 when they are opened but other scanners seem to default to a stored value, perhaps the last user-selected value. This setting usually affects only 1-bit scans i.e. PixelType == TWPT_BW. This setting applies to document scanners, and perhaps film scanners it is likely to be omitted or ignored by cameras and video digitizers. A few low-cost scanners will accept this setting without error, but then ignore the value! As an alternative to setting the scanner threshold, consider scanning in grayscale (pixel type TWPT_GRAY) and converting the images to B&W in software, using EZTwain functions such as DIB_SmartThreshold.

TWAIN_GetCurrentThreshold
double TWAIN_GetCurrentThreshold(void)
Try to get the current B&W threshold setting the value of the ICAP_THRESHOLD capability. If this fails for any reason, it will return -1. Note: EZTwain *VERSIONS BEFORE 2.65 RETURNED 128.0*

Page 115

EZTwain Pro User Guide

TWAIN_SetAutoBright
int TWAIN_SetAutoBright(BOOL bOn)

TWAIN_SetLightPath
int TWAIN_SetLightPath(BOOL bTransmissive)
Tries to select transparent or reflective media for scanning. A parameter of TRUE(1) means transparent media (transparency scanning), FALSE(0) means reflective media. A return of TRUE(1) implies success, FALSE(0) means that the Source refused the request.

TWAIN_SetGamma
int TWAIN_SetGamma(double dGamma)

TWAIN_SetShadow
int TWAIN_SetShadow(double d) // 0..255

TWAIN_SetHighlight
int TWAIN_SetHighlight(double d) // 0..255

Page 116

EZTwain Pro User Guide

Document Feeder Control

TWAIN_HasFeeder
BOOL TWAIN_HasFeeder(void)
Return TRUE(1) if the source indicates it has a document feeder, FALSE(0) otherwise. You will need to have a device open for this query to work.

TWAIN_IsFeederSelected
BOOL TWAIN_IsFeederSelected(void)
Return TRUE(1) if the document feeder is selected. A device must be open.

TWAIN_SelectFeeder
int TWAIN_SelectFeeder(int fYes)
(Try to) select or deselect the document feeder. Return TRUE(1) if successful, FALSE(0) otherwise.

TWAIN_IsAutoFeedOn
BOOL TWAIN_IsAutoFeedOn(void)
Return TRUE(1) if automatic feeding is enabled, otherwise FALSE(0). Make sure the feeder is selected before calling this function.

TWAIN_SetAutoFeed
int TWAIN_SetAutoFeed(int fYes)
(Try to) turn on/off automatic feeding thru the feeder. Return TRUE(1) if successful, FALSE(0) otherwise. This function selects the feeder, so to start scanning pages from an ADF, just do: TWAIN_SetAutoFeed(TRUE).

TWAIN_SetAutoScan
int TWAIN_SetAutoScan(int fYes)
(Try to) turn on/off scan-ahead (CAP_AUTOSCAN). Returns TRUE(1) if successful, FALSE(0) otherwise. This is an optional feature supported by some ADF scanners. When enabled, the scanner will scan pages before they are requested, buffering them in the scanner or host PC. When disabled, the scanner will not feed and scan a page until the application asks for it. Used to achieve maximum throughput on ADF scanners. Note: A few high-speed scanners (e.g. Kodak i200) have this capability permanently on such scanners always scan all pages in the feeder once they start.

TWAIN_IsFeederLoaded
BOOL TWAIN_IsFeederLoaded(void)

Page 117

EZTwain Pro User Guide

Return TRUE(1) if there are documents in the feeder. Make sure the feeder is selected before calling this function.

Page 118

EZTwain Pro User Guide

Duplex Control
Many office scanners are capable of duplex scanning this means scanning both sides of an original. Scanning just one side of each page is called simplex scanning. But how does the image of the other side get transferred? EZTwain treats duplex scanning the same way TWAIN does: As pairs of separate transfers. When the scanner scans a page in duplex mode, it queues up two transfers (the front of the page, then the back.) If you want to support this, you will want to use multi-transfer mode (see TWAIN_SetMultiTransfer). Your first Acquire call will transfer the front of the page, the next Acquire will transfer the back, and so on.

TWAIN_GetDuplexSupport
int TWAIN_GetDuplexSupport(void)
Query the device for duplex scanning support. Return values: 0 = no support (or error, or query not recognized) 1 = 1-pass duplex 2 = 2-pass duplex

TWAIN_EnableDuplex
int TWAIN_EnableDuplex(int fYes)
Enable (fYes=1) or disable (fYes=0) duplex scanning. Returns TRUE(1) if successful, FALSE(0) otherwise.

TWAIN_IsDuplexEnabled
BOOL TWAIN_IsDuplexEnabled(void)
Returns TRUE(1) if the device supports duplex scanning and duplex scanning is enabled. FALSE(0) otherwise.

Page 119

EZTwain Pro User Guide

Other Settings
TWAIN_HasControllableUI
int TWAIN_HasControllableUI(void)
Return 1 if source claims UI can be hidden (see SetHideUI above) Return 0 if source says UI *cannot* be hidden Return -1 if source (pre TWAIN 1.6) cannot answer the question.

TWAIN_SetIndicators
int TWAIN_SetIndicators(BOOL bVisible)
Tell the source to show (hide) progress indicators during acquisition.

TWAIN_SetXferMech / TWAIN_XferMech
int TWAIN_SetXferMech(int mech) int TWAIN_XferMech(void)
Try to set or get the transfer mode - one of the following:

#define XFERMECH_NATIVE #define XFERMECH_FILE #define XFERMECH_MEMORY

1 2

Normally you do not need to set this mode the Acquire functions will select the transfer mode they need.

TWAIN_NegotiatePixelTypes
int TWAIN_NegotiatePixelTypes(unsigned wPixTypes)
Negotiate with the source to specify a set of pixel types that can be acquired. Note that this function does not take pixel type codes - it requires pixel mask codes: See TWAIN_AcquireNative for some mask constants. A parameter of 0 (TWAIN_ANYTYPE) causes no negotiation & no restriction. You should not assume that the source will honor your restrictions, even if this call succeeds! Returns: 1 for success, 0 for failure. If you want to select one specific pixel type, see TWAIN_SetPixelType 113.

TWAIN_SupportsFileXfer
int TWAIN_SupportsFileXfer(void)
Returns TRUE(1) if the open Source claims to support file transfer mode (XFERMECH_FILE) This mode is optional. If TRUE, you can use AcquireFile.

Page 120

EZTwain Pro User Guide

Raw Capability Get & Set

Note that ordinarily capabilities can be Set or Reset only in State 4 (Source Open) and can be read (Get, GetCurrent, GetDefault) only in State 4 or higher.

TWAIN_Get
HCONTAINER TWAIN_Get(unsigned uCap)
Issue a DAT_CAPABILITY/MSG_GET to the open source. Return a capability 'container' - the 'MSG_GET' value of the capability. Use CONTAINER_* functions to examine and modify the container object. Use CONTAINER_Free to release it when you are done with it. A return value of 0 indicates failure: Call GetConditionCode or ReportLastError.

TWAIN_GetDefault
HCONTAINER TWAIN_GetDefault(unsigned uCap)
Issue a DAT_CAPABILITY/MSG_GETDEFAULT, to get the default value of the specified capability.

TWAIN_GetCurrent
HCONTAINER TWAIN_GetCurrent(unsigned uCap)
Issue a DAT_CAPABILITY/MSG_GETCURRENT to get the current value of the specified capability. Caution: A few Sources will not respond to GetCurrent, but only Get implying that Get represents the current value.

TWAIN_Set
int TWAIN_Set(unsigned uCap, HCONTAINER hcon)
Issue a DAT_CAPABILITY/MSG_SET to the open source, using the specified capability and container. Returns 1 (TRUE) if successful, 0 (FALSE) otherwise.

TWAIN_Reset
int TWAIN_Reset(unsigned uCap)
Issue a MSG_RESET, which should reset the specified capability to its default value. Returns 1 (TRUE) if successful, 0 (FALSE) otherwise.

TWAIN_GetCapBool
BOOL TWAIN_GetCapBool(unsigned cap, BOOL bDefault)
Issue a DAT_CAPABILITY/MSG_GETCURRENT on the specified capability to get the value as a BOOL. Returns the capability value if successful, otherwise returns bDefault.

Page 121

EZTwain Pro User Guide

TWAIN_GetCapFix32
double TWAIN_GetCapFix32(unsigned cap, double dDefault)

TWAIN_GetCapUint16
int TWAIN_GetCapUint16(unsigned cap, int nDefault)

TWAIN_SetCapability
int TWAIN_SetCapability(unsigned Cap, double dVal)
Set the value of a capability of unknown type - such as a custom (proprietary) capability. This is like TWAIN_SetCapOneValue, but you dont have to look up or discover the ItemType. Only useful on capabilities that have a simple current value that is an integer or fractional number. Only valid in State 4. Return Value: TRUE (1) if successful, FALSE (0) otherwise. Example:

Tell Canon DR2080 to skip blank pages: TWAIN_SetCapability(&H8001, 1)

TWAIN_SetCapBool
int TWAIN_SetCapBool(unsigned Cap, BOOL bVal)
Set the value of a capability that has type TWTY_BOOL. Only valid in State 4. Return Value: TRUE (1) if successful, FALSE (0) otherwise.

TWAIN_SetCapOneValue
int TWAIN_SetCapOneValue(unsigned Cap, unsigned ItemType, long ItemVal)
Do a DAT_CAPABILITY/MSG_SET, on capability 'Cap' (e.g. ICAP_PIXELTYPE, CAP_AUTOFEED, etc.) using a TW_ONEVALUE container with the given item type and value. Use SetCapFix32 for capabilities that take a FIX32 value, use SetCapOneValue for the various ints and uints. These functions do not support FRAME or STR items. Return Value: TRUE (1) if successful, FALSE (0) otherwise.

TWAIN_SetCapFix32 / TWAIN_SetCapFix32R
int TWAIN_SetCapFix32(unsigned Cap, double dVal) int TWAIN_SetCapFix32R(unsigned Cap, int Num, int Den)
Do a DAT_CAPABILITY/MSG_SET on capability Cap using a TW_ONEVALUE container of a FIX32 item. Return Value: TRUE (1) if successful, FALSE (0) otherwise. Use SetCapFix32 and SetCapFix32R for capabilities that take a FIX32 value. SetCapFix32R uses the value dVal = Num/Den. This is useful for languages that make it hard to pass double parameters.

Page 122

EZTwain Pro User Guide

Region of Interest (ROI)

In the jargon of imaging, region-of-interest (ROI) means a particular rectangular region to be processed, out of a larger image area. If you have used a flatbed scanner, you have seen this concept in the scanners user interface: Within the full scanning area, you can select a smaller rectangle to scan.

TWAIN_SetRegion
void TWAIN_SetRegion(double L, double T, double R, double B)
This is the most general and powerful function in EZTwain for selecting a region-of-interest. It will try to use the region-scanning abilities of the device, but if the device cant or wont scan the specified region, EZTwain crops each incoming image to the specified area. Caution: The parameters are NOT x, y, width and height they are left, top, right, and bottom of the area to scan, measured in the current unit of measure from the top-left corner of the 'original page'. See the diagram to the right. Caution: Some devices (For example, some Fujitsu fiseries) remember the last paper size selected in their user interface, and will not accept a region setting outside that paper size. To avoid this problem, call TWAIN_SetPaperSize before calling TWAIN_SetRegion. Example: The following code, with an 8.5 x 11 flatbed scanner, will scan a 3 x 4 square towards the center of the platen, in color at 300dpi, and save it as a TIFF file:

If (TWAIN_OpenDefaultSource()) { TWAIN_SetUnits(TWUN_INCHES); TWAIN_SetResolution(300); TWAIN_SetPixelType(TWPT_RGB); TWAIN_SetRegion(2.0, 3.0, 5.0, 7.0); // scan starts 2" from left side, 3" from top // scan stops 5" from left side, 7" from top. // scan is 5.0-2.0 = 3" wide and 7.0-3.0 = 4" high TWAIN_SetHideUI(1); TWAIN_AcquireToFilename(0, "myfile.tif"); }

TWAIN_ResetRegion
void TWAIN_ResetRegion(void)
Resets the region set with TWAIN_SetRegion, so that EZTwain stops trying to set or crop to a region of interest.

Page 123

EZTwain Pro User Guide

TWAIN_SetImageLayout
int TWAIN_SetImageLayout(double L, double T, double R, double B)
Lower-level region-of-interest (ROI) function. Set the area to scan, using DAT_IMAGELAYOUT/MSG_SET. Note: Even though the TWAIN standard lists this feature as required most cameras ignore it, along with some ADF scanners and other devices. This call is only valid in State 4 that is, when a device is open. L, T, R, B = distance to left, top, right, and bottom edge respectively of area to scan, measured in the current unit of measure from the top-left corner of the 'original page' (TWAIN 1.6 8-22). See the warning below about units. Returns TRUE (1) if successful, FALSE (0) otherwise. Common causes of failure: 1. Not in State 4 / Source open. See TWAIN_OpenDefaultSource. 2. The device does not support image layout. 3. Incorrect parameters see the example below. Do not assume that image layout is pixel-precise. Many devices deliver images that differ from the requested image layout by a few pixels in width or height. In theory the numbers used in image layout are measurements in the current unit of measure (see TWAIN_GetCurrentUnits / TWAIN_SetUnits.) In practice quite a few TWAIN devices ignore the unit setting and always measure image layout in inches.

TWAIN_GetImageLayout / TWAIN_GetDefaultImageLayout
int TWAIN_GetImageLayout(double *L, double *T, double *R, double *B) int TWAIN_GetDefaultImageLayout(double *L, double *T, double *R, double *B)
Get the current or default (power-on) area to scan. See the warning above about units. This call is valid in States 4-6. Return value: 1 = success, 0 = failure.

TWAIN_ResetImageLayout
int TWAIN_ResetImageLayout(void)
Reset the scan area to the default (power-on) settings. This call is only valid in State 4. Return value: 1 = success, 0 = failure.

Page 124

EZTwain Pro User Guide

TWAIN_SetFrame
int TWAIN_SetFrame(double L, double T, double R, double B)
This is an alternative way to set the scan area. Some scanners will respond to this instead of SetImageLayout. Return value: 1 = success, 0 = failure. This call is only valid in State 4, when a Source is open. L, T, R, B = distance to left, top, right, and bottom edge of the area to scan, measured in the current unit of measure.

Page 125

EZTwain Pro User Guide

TWAIN_SetPaperSize
int TWAIN_SetPaperSize(int nPaper)
Asks the scanner to scan a specific standard paper size. Note: Some devices support this, some dont. Beginning with EZTwain Pro 3.05, if the Source refuses to set the requested paper size, TWAIN_SetPaperSize will try the two other ways to select the scan area: TWAIN_SetImageLayout and TWAIN_SetFrame. Caution: TWAIN defines no default paper size. This means that when you open a device, it is free to select whatever paper size it feels like. If you are running a device with its user interface suppressed, we recommend that you call TWAIN_SetPaperSize. This may fail, but when it does the device usually has a reasonable default such as 8.5 x 11 inches, or the device's maximum scan area. Standard TWAIN Paper Sizes Constant Name PAPER_NONE PAPER_A4LETTER PAPER_B5LETTER PAPER_USLETTER PAPER_USLEGAL PAPER_A5 PAPER_B4 PAPER_B6 PAPER_USLEDGER PAPER_USEXECUTIVE PAPER_A3 PAPER_B3 PAPER_A6 PAPER_C4 PAPER_C5 PAPER_C6 PAPER_4A0 PAPER_2A0 PAPER_A0 PAPER_A1 Value Value 0 1 2 3 4 5 6 7 9 10 11 12 13 14 15 16 17 18 19 20 Constant Name

Page 126

EZTwain Pro User Guide

PAPER_A2 PAPER_A7 PAPER_A8 PAPER_A9 PAPER_A10 PAPER_ISOB0 PAPER_ISOB1 PAPER_ISOB2 PAPER_ISOB5 PAPER_ISOB7 PAPER_ISOB8 PAPER_ISOB9 PAPER_ISOB10 PAPER_JISB0 PAPER_JISB1 PAPER_JISB2 PAPER_JISB3 PAPER_JISB4 PAPER_JISB6 PAPER_JISB7 PAPER_JISB8 PAPER_JISB9 PAPER_JISB10 PAPER_C0 PAPER_C1 PAPER_C2 PAPER_C3 PAPER_C7 PAPER_C8 PAPER_C9 PAPER_C10 PAPER_USSTATEMENT PAPER_BUSINESSCARD

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

Page 127

EZTwain Pro User Guide

TWAIN_GetPaperDimensions
BOOL TWAIN_GetPaperDimensions(int nPaper, int nUnits, double *pdW, double *pdH)
Retrieves the width and height of a standard paper size, in specified units. For nPaper, use one of the PAPER_ codes listed above. For nUnits, use one of the TWUN_ unit codes, such as TWUN_INCHES(0) or TWUN_CENTIMETERS(1). For pdW and pdH, pass pointers to 64-bit double-precision floating point variables or in languages that support passing parameters by reference, pass the names of two double-precision float variables. Returns TRUE(1) if successful. Returns FALSE(0) if nPaper or nUnits are invalid (unrecognized) values.

Page 128

EZTwain Pro User Guide

Tone Control
TWAIN_SetGrayResponse
int TWAIN_SetGrayResponse(const long pcurve[256])
Define a translation of gray pixel values. When device digitizes a pixel with value V, that pixel is translated to value pcurve[V] before it is returned to the application. Caution: Supported by few devices. Device must be open (State 4), Current PixelType must be TWPT_GRAY or TWPT_RGB, current BitDepth should be 8. pcurve must be a table (array, vector) of 256 entries.

TWAIN_SetColorResponse
int TWAIN_SetColorResponse(const long pred[256], const long pgreen[256], const long pblue[256])
Define a translation of color values. Like TWAIN_SetGrayResponse (above) but separate translation can be applied to each color channel. Supported by few devices.

TWAIN_ResetGrayResponse/ TWAIN_ResetColorResponse
int TWAIN_ResetGrayResponse(void) int TWAIN_ResetColorResponse(void)
These two functions reset the response curve to map every value V to itself i.e. a 'do nothing' translation.

Page 129

EZTwain Pro User Guide

Functions Settings Dialog

TWAIN_DoSettingsDialog
int TWAIN_DoSettingsDialog(HWND hwnd)
Display the device's settings dialog and allow the user to adjust any or all settings. This function returns when the user closes the dialog. This feature is optional in TWAIN. If a device has a settings dialog, it is normally very similar to the device's scanning dialog, with the [Scan] button replaced with an [OK] button. To a first approximation, this feature is supported by no cameras, few flatbeds, and not all document scanners. A device may remember its settings when it is closed and re-opened, but it may not: TWAIN does not require this. You can use TWAIN_GetCustomDataToFile (below) to save all the settings of a device, and TWAIN_SetCustomDataFromFile to restore them later. Any device that supports a settings dialog supports the CustomData functions. If a device is open, uses that device. If no device is currently open, uses the default device. To check if a device supports this, open the device and call TWAIN_GetCapBool(CAP_ENABLEDSUIONLY, FALSE) which should return TRUE(1) if the device supports this feature. Return values: 1 dialog was displayed and user clicked OK 0 dialog was displayed and user clicked Cancel -1 dialog not displayed - some error. Call TWAIN_LastErrorCode, ReportLastError, or similar function for more details.

TWAIN_EnableSourceUiOnly
int TWAIN_EnableSourceUiOnly(HWND hwnd)
This is the underlying 'asynchronous' function for TWAIN_DoSettingsDialog. Opens the device's settings dialog, if this is supported. Returns TRUE (1) if successful, FALSE (0) otherwise. Note: If successful, this call leaves the dialog open, so your program must run a message pump at least until the user closes it. If you don't understand what that means, don't call this function! Use TWAIN_DoSettingsDialog, above.

Page 130

EZTwain Pro User Guide

Functions Custom DS Data

These functions support an optional feature of TWAIN that allows the application to read or write all the settings of a TWAIN device in a single operation. This a good news/bad news feature: Good: 1. (If implemented properly) it reads and writes all settings of the device, even settings that are not accessible through TWAIN, like melt film after scanning and pixel thickness. Or... the imprinter step size and direction on Fujitsu fi series scanners. 2. When supported, its a great way to set a scanner to a predefined, completely known state. Bad: 1. It is not universally supported: no cameras that we have seen, not so many flatbeds, not all document scanners. 2. The format of the saved settings is vendor-specific. If you parse the data, you are tied to that vendor, and possibly to that specific model and/or device driver. Support for this feature can be tested when a device is open, by reading the value of the Boolean capability CAP_CUSTOMDSDATA. In C:

if (TWAIN_GetCapBool(CAP_CUSTOMDSDATA, FALSE)) {

TWAIN_GetCustomDataToFile
int TWAIN_GetCustomDataToFile(string pzFile)
Takes a file specification, reads the Custom DS Data from the device and saves it in the file. An existing file will be overwritten. Only valid in State 4 a device must be open. See TWAIN_OpenSource, 110. The device must support this optional feature, see above. Returns TRUE(1) if successful, FALSE(0) otherwise.

TWAIN_SetCustomDataFromFile
int TWAIN_SetCustomDataFromFile(string pzFile)
Takes a file specification, reads the Custom DS Data from the file and writes it to the device. The file must exist. Only valid in State 4 a device must be open. See TWAIN_OpenSource, 110. The device must support this optional feature, see above. Returns TRUE(1) if successful, FALSE(0) otherwise.

Page 131

EZTwain Pro User Guide

Functions Container
For theory and practice of using containers, see the section How To: Work with Containers (p 155).

CONTAINER_Free
void CONTAINER_Free(HCONTAINER hcon) Free the memory and resources of a capability container.

CONTAINER_Copy
HCONTAINER CONTAINER_Copy(HCONTAINER hcon)
Create an exact copy of the container.

CONTAINER_Equal
BOOL CONTAINER_Equal(HCONTAINER hcon1, HCONTAINER hcon2)
Return TRUE (1) if all properties of hcon1 and hcon2 are the same. Otherwise return FALSE (0).

CONTAINER_IsValid
BOOL CONTAINER_IsValid(HCONTAINER hcon)
Returns 1 (TRUE) if the container seems to be valid, 0 (FALSE) if not. A valid container is one that will not cause errors or exceptions if accessed with the other CONTAINER_ functions.

CONTAINER_Format
int CONTAINER_Format(HCONTAINER hcon)
Container formats, same codes as in TWAIN.H CONTAINER_ARRAY 3 CONTAINER_ENUMERATION 4 CONTAINER_ONEVALUE 5 CONTAINER_RANGE 6 Return the 'format' of this container: CONTAINER_ONEVALUE, etc.

CONTAINER_ItemCount
int CONTAINER_ItemCount(HCONTAINER hcon)
Return the number of values in the container. For a ONEVALUE, return 1.

CONTAINER_ItemType
int CONTAINER_ItemType(HCONTAINER hcon)
Return the item type (what exact kind of values are in the container.) See the TWTY_* definitions in TWAIN.H

CONTAINER_TypeSize
int CONTAINER_TypeSize(int nItemType)
Return the size in bytes of an item of the specified type (TWTY_*)

Page 132

EZTwain Pro User Guide

CONTAINER_FloatValue / CONTAINER_IntValue
double CONTAINER_FloatValue(HCONTAINER hcon, int n) int CONTAINER_IntValue(HCONTAINER hcon, int n)
Return the value of the nth item in the container. n is forced into the range 0 to ItemCount(hcon)-1.

CONTAINER_StringValue / CONTAINER_GetStringValue
string CONTAINER_StringValue(HCONTAINER hcon, int n) void CONTAINER_GetStringValue(HCONTAINER hcon, int n, LPSTR pzText)

Return the nth value in a container, in the form of a string. The first form is a function that returns the string as its value. (Not available in VB.) The second form expects a string variable as its 3rd parameter - in most languages, the string must be pre-allocated with enough space to hold the returned value - see n is forced into the range 0 to ItemCount(hcon)-1.

CONTAINER_ValuePtr
BYTE* CONTAINER_ValuePtr(HCONTAINER hcon, int n)

CONTAINER_ContainsValue
int CONTAINER_ContainsValue(HCONTAINER hcon, double d)
Return 1 (TRUE) if the value d is one of the items in the container.

CONTAINER_FindValue
int CONTAINER_FindValue(HCONTAINER hcon, double d)
Return the index of the value d in the container, or -1 if not found.

CONTAINER_CurrentValue / CONTAINER_DefaultValue
double CONTAINER_CurrentValue(HCONTAINER hcon) double CONTAINER_DefaultValue(HCONTAINER hcon)
Return the container's current or power-up (default) value. Array containers do not have these and will return -1.0. OneValue containers always return their (one) value.

CONTAINER_CurrentIndex / CONTAINER_DefaultIndex
int CONTAINER_DefaultIndex(HCONTAINER hcon) int CONTAINER_CurrentIndex(HCONTAINER hcon)
Return the index of the Default or Current value, in an Enumeration. Return -1 if the container is not an Enumeration.

CONTAINER_MinValue / CONTAINER_MaxValue / CONTAINER_StepSize

double CONTAINER_MinValue(HCONTAINER hcon) double CONTAINER_MaxValue(HCONTAINER hcon) double CONTAINER_StepSize(HCONTAINER hcon)

Return the three parameters that define a Range container. Returns -1.0 if the container is not a Range.

Page 133

EZTwain Pro User Guide

CONTAINER_OneValue / CONTAINER_Array
HCONTAINER CONTAINER_OneValue (int nItemType, double dVal) HCONTAINER CONTAINER_Array (int nItemType, int nItems)
These functions create containers from scratch: nItemType is one of the TWTY_* item types from TWAIN.H nItems is the number of items, in an array or enumeration.

CONTAINER_Range / CONTAINER_Enumeration
HCONTAINER CONTAINER_Range(int nItemType, double dMin, double dMax, double dStep) HCONTAINER CONTAINER_Enumeration(int nItemType, int nItems)
These functions create containers from scratch: nItemType is one of the TWTY_* item types from TWAIN.H nItems is the number of items, in an array or enumeration. dMin, dMax, dStep are the beginning, ending, and step value of a range.

CONTAINER_SetItem / CONTAINER_SetItemString
int CONTAINER_SetItem(HCONTAINER hcon, int n, double dVal) int CONTAINER_SetItemString(HCONTAINER hcon, int n, LPCTSTR pzVal)
Set the nth item of the container to dVal or pzText. NOTE: A OneValue is treated as an array with 1 element. Return 1 (TRUE) if successful. 0 (FALSE) for failure: The container is not an array, enumeration, or onevalue n < 0 or n >= CONTAINER_ItemCount(hcon) the value cannot be represented in this container's ItemType.

CONTAINER_SetItemFrame
int CONTAINER_SetItemFrame(HCONTAINER hcon, int n, double l, double t, double r, double b)
Set the nth item of the container to frame(l,t,r,b). NOTE: A OneValue is treated as an array with 1 element. Return 1 (TRUE) if successful. 0 (FALSE) for failure: The container is not an array, enumeration, or onevalue n < 0 or n >= CONTAINER_ItemCount(hcon) the value cannot be represented in this container's ItemType.

CONTAINER_SelectDefaultValue / CONTAINER_SelectDefaultItem
int CONTAINER_SelectDefaultValue(HCONTAINER hcon, double dVal) int CONTAINER_SelectDefaultItem(HCONTAINER hcon, int n)

CONTAINER_SelectCurrentValue / CONTAINER_SelectCurrentItem
int CONTAINER_SelectCurrentValue(HCONTAINER hcon, double dVal) int CONTAINER_SelectCurrentItem(HCONTAINER hcon, int n)

Page 134

EZTwain Pro User Guide

Select the current or default value within an enumeration or range, by specifying either the value, or its index. Returns 1 (TRUE) if successful, 0 (FALSE) otherwise. This will fail if: The container is not an enumeration or range. dVal is not one of the values in the container n < 0 or n >= CONTAINER_ItemCount(hcon)

CONTAINER_DeleteItem
int CONTAINER_DeleteItem(HCONTAINER hcon, int n)
Delete the nth item from an Array or Enumeration container. Returns 1 (TRUE) for success, 0 (FALSE) otherwise. Failure causes: invalid container handle container is not an array or enumeration n < 0 or n >= ItemCount(hcon)

CONTAINER_InsertItem
int CONTAINER_InsertItem(HCONTAINER hcon, int n, double dVal)
Insert an item with value dVal into the container at position n. If n = -1, the item is inserted at the end of the container.

Page 135

EZTwain Pro User Guide

Functions Testing & Validation

TWAIN_Testing123
HANDLE TWAIN_Testing123(string pz, int n, HANDLE h, double d, unsigned u)
Display a dialog box with the parameter values in it. Use this to test that you can call EZTwain and pass parameters correctly. It returns the value of the HANDLE h parameter.

TWAIN_SelfTest
int TWAIN_SelfTest(unsigned f)
Perform internal self-test. Parameters f ignored for now Return Values 0 success other internal test failed.

Page 136

EZTwain Pro User Guide

Functions Obscure (Even for TWAIN)

TWAIN_AutoClickButton
Void TWAIN_AutoClickButton(string pzButtonName)
This odd little function can be used, sometimes, to automate image transfers from a device that insists on displaying a user interface dialog. Call this function before calling an Acquire function. When the Acquire starts and the device dialog pops up, EZTwain will search the dialog for a button with the specified name and simulate the user clicking that button. If you pass a null string to this function, it looks for a button with one of the common (English) labels: Scan, Capture, Start Scan, Take Picture, Scan Now. Case differences are ignored (A is the same as a) as are the underlined letters in some button labels.

TWAIN_RegisterApp
void TWAIN_RegisterApp ( int nMajorNum, // version numbers are treated as int nMinorNum, // nMajorNum.nMinorNum int nLanguage, // language (see TWLG_xxx in TWAIN.H) int nCountry, // country (see TWCY_xxx in TWAIN.H) string lpszVer, // version as string e.g. "1.0b3 beta" string lpszMfg, // vendor e.g. "Zzzzip Software" string lpszFam, // product family e.g. "Whooshy" string lpszApp) // specific product e.g. "Whooshy Paint"
This is the long form of TWAIN_SetAppTitle, and need only be used if you know that some Source needs the additional information. TWAIN_RegisterApp should be called as one of the first EZTwain calls.

TWAIN_Blocked
int TWAIN_Blocked(void)
Returns 1 if processing is inside the TWAIN Source Manager or a Source, 0 otherwise. If TWAIN is blocked, EZTwain Pro 2.95 and later will fail any operation that would require a call into TWAIN otherwise such calls almost always deadlock.

TWAIN_UserClosedSource
int TWAIN_UserClosedSource(void) Return TRUE (1) if during the last acquire the user asked the Source to close. 0 otherwise of course. This flag is cleared each time you start any kind of acquire, and it is set if EZTwain receives a MSG_CLOSEDSREQ message through TWAIN.

TWAIN_BuildName
char* TWAIN_BuildName(void)
Return a string describing the build of EZTwain e.g. "Beta1 Debug"

Page 137

EZTwain Pro User Guide

TWAIN_GetBuildName
void TWAIN_GetBuildName(LPSTR psName)

TWAIN_AcquireMemoryCallback
BOOL TWAIN_AcquireMemoryCallback(HWND hwnd, MEMXFERCALLBACK cb, LPVOID data) typedef BOOL (WINAPI *MEMXFERCALLBACK)(LPVOID data); Like TWAIN_AcquireMemory, but you provide a call-back function. The call-back is called when the transfer is ready, and is responsible for setting up the transfer, transferring the data, and doing clean-up.

TWAIN_SetCompression / TWAIN_Compression
int TWAIN_Compression(void) int TWAIN_SetCompression(int compression)
Set/Return compression style for transferred data. See twain.h for TWCP_xxx values to use with this capability. The meaning of this capability depends (in theory) on the current transfer mode (see TWAIN_XferMech) If the transfer mode is File, this capability should reflect the compression that will be used in the transferred file. If the transfer mode is Memory, then this is how the incoming buffers of data will be compressed. Note: The EZTwain function TWAIN_AcquireMemory cannot handle compressed data. If you want to do compressed memory transfers, you will have to code them at a lower level, possibly using TWAIN_AcquireMemoryCallback

TWAIN_SetTiled / TWAIN_Tiled
BOOL TWAIN_Tiled(void) int TWAIN_SetTiled(BOOL bTiled)
Set/Return whether source does memory xfer via strips or tiles. bTiled = TRUE if it uses tiles for transfer.

TWAIN_SetPlanarChunky / TWAIN_PlanarChunky
int TWAIN_PlanarChunky(void) int TWAIN_SetPlanarChunky(int shape)
Set/Return current pixel packing for memory transfers. See the TWAIN specification for details.

TWAIN_SetPixelFlavor / TWAIN_PixelFlavor
int TWAIN_PixelFlavor(void) int TWAIN_SetPixelFlavor(int flavor)
Set/Return pixel 'flavor' - whether 0 is black or white: #define CHOCOLATE_PIXELS 0 // zero pixel represents darkest shade #define VANILLA_PIXELS 1 // zero pixel represents lightest shade Page 138

EZTwain Pro User Guide

TWAIN_GetCapCurrent
int TWAIN_GetCapCurrent(unsigned Cap, unsigned ItemType, void FAR *pVal)
Do a DAT_CAPABILITY/MSG_GETCURRENT on capability 'Cap'. Copy the current value out of the returned container into *pVal. If the operation fails (the source refuses the request), or if the container is not a ONEVALUE or ENUMERATION, or if the item type of the returned container is incompatible with the expected TWTY_ type in ItemType, returns FALSE. If this function returns FALSE, *pVal is not touched.

TWAIN_ToFix32 / TWAIN_ToFix32R
long TWAIN_ToFix32(double d)
Convert a floating-point value to a 32-bit TW_FIX32 value that can be passed to e.g. TWAIN_SetCapOneValue.

long TWAIN_ToFix32(int Numerator, int Denominator)

Convert a rational number to a 32-bit TW_FIX32 value. Returns a TW_FIX32 value that approximates Numerator/Denominator

TWAIN_Fix32ToFloat
double TWAIN_Fix32ToFloat(long nfix)
Convert a TW_FIX32 value (as returned from some capability inquiries) to a double (floating point) value.

TWAIN_MessageHook
int TWAIN_MessageHook(LPMSG lpmsg)
This function detects Windows messages that should be routed to an enabled Source, and picks them off. In a full TWAIN app, TWAIN_MessageHook is called inside the main GetMessage loop, whose skeleton code looks like something like this:

Page 139

EZTwain Pro User Guide

MSG msg; BOOL bGot; while ((bGot = GetMessage((LPMSG)&msg, NULL, 0, 0)) != 0) { if (bGot < 0) { // something weird. } else if (!TWAIN_MessageHook ((LPMSG)&msg)) { TranslateMessage ((LPMSG)&msg); DispatchMessage ((LPMSG)&msg); } } // while

TWAIN_WaitForNativeXfer
HANDLE TWAIN_WaitForNativeXfer(HWND hwnd)

TWAIN_IsTransferReady
int TWAIN_IsTransferReady(void)

TWAIN_GetSourceIdentity
int TWAIN_GetSourceIdentity(LPVOID ptwid)
Get a copy of the TW_IDENTITY structure (see twain.h) used inside EZTwain to hold information about the current / most recently opened Source.

TWAIN_DS
int TWAIN_DS(unsigned long DG, unsigned DAT, unsigned MSG, void FAR *pData)
TWAIN_DS passes the triplet (DG, DAT, MSG, pData) to the open Source if any. Returns 1 (TRUE) if the operation is successful, 0 (FALSE) otherwise. The last result code can be retrieved with TWAIN_GetResultCode(), and the corresponding condition code can be retrieved with TWAIN_GetConditionCode(). If no source is open this call will fail, result code TWRC_FAILURE, condition code TWCC_NODS. This function plus TWAIN_Mgr below give you direct access to the TWAIN API, although this function does provide two hidden services: It tracks the TWAIN state, and it traps exceptions inside TWAIN and turns them into failure returns.

TWAIN_Mgr
int TWAIN_Mgr(unsigned long DG, unsigned DAT, unsigned MSG, void FAR *pData)
Pass a triplet to the Source Manager (DSM). Returns 1 (TRUE) for success, 0 (FALSE) otherwise. See GetResultCode, GetConditionCode, and ReportLastError functions for diagnosing and reporting a TWAIN_Mgr failure.

Page 140

EZTwain Pro User Guide

If the Source Manager is not open, this call fails setting result code TWRC_FAILURE, and condition code=TWCC_SEQERROR (triplet out of sequence). This function with TWAIN_DS above give you direct access to the TWAIN API.

Page 141

EZTwain Pro User Guide

Functions Deprecated
TWAIN_FreeNative
void TWAIN_FreeNative(HANDLE hdib) Identical to DIB_Free, please use that instead.

DIB_WriteToBmp
int DIB_WriteToBmp(HANDLE hdib, string pszFile)

DIB_WriteToJpeg
int DIB_WriteToJpeg(HANDLE hdib, string pszFile)
Note: -3 is returned when attempting to write a Jpeg file from an image that is not 24-bit color or 8-bit grayscale. 1-bit B&W images cannot be saved as JPEG.

DIB_WriteToPng
int DIB_WriteToPng(HANDLE hdib, string pszFile)

DIB_WriteToGif
int DIB_WriteToGif(HANDLE hdib, string pszFile)
Note: EZTwain automatically converts 24-bit color to 8-bit palette color when writing to GIF format.

DIB_WriteToDcx
int DIB_WriteToDcx(HANDLE hdib, string pszFile)
Note: EZTwain automatically converts all image formats to 1-bit B&W when writing to DCX format.

DIB_WriteToTiff
int DIB_WriteToTiff(HANDLE hdib, string pszFile)
See also: TIFF Special Features 89.

DIB_WriteToPdf
int DIB_WriteToPdf(HANDLE hdib, string pszFile)
Note: a return value of -3 indicates an invalid hdib handle, or 'no support for this format'. .

Page 142

EZTwain Pro User Guide

Glossary
BMP (BitMaP) File
The standard raster image file format used by Microsoft Windows. BMP files can store 1-bit, 4-bit, 8-bit, and 24-bit (per pixel) images, and much less commonly, 16bit and 32-bit images. While there is an optional compression for BMP files, it is rarely used and is particularly unsuitable for continuous tone images. A BMP file is simply a DIB (q.v.) with a small header stuck in front.

Capability
TWAIN term for a property or setting of a device, that is accessible (exposed) to TWAIN applications. Every standard capability is given a name and code. Some capabilities are read-only, such as CAP_PAPERDETECTABLE, which has the value TRUE or FALSE depending on whether the device can detect paper in its document feeder. A device that has no document feeder will not even have this capability. Other capabilities can be read and modified by the application, and can have complex behavior: For example, ICAP_PIXELTYPE describes the kind of pixels the device can deliver. Most scanners can deliver 1-bit Black & White, Grayscale, or RGB Color, and will allow the application to specify which it would like, but a webcam may offer only RGB, and reject an attempt to set any other value.

Container
TWAIN term for a global memory block holding one or more values or data items, used to represent a capability value i.e. a property or setting of a device.

Datasource (Source, Data Source, DS)

A device-specific TWAIN interface module. In some ways, a Source is just a glorified driver but a TWAIN Source is different from a conventional driver in three ways: 1. A Source has a user interface typically a dialog box, sometimes an elaborate collection of overlapping windows. 2. A Source runs as part of the client application i.e. your program. It is in fact a DLL, and functions as a temporary extension of the application. This is radically different from typical device drivers that run inside the protected shell of the OS. 3. A Source in most cases does not communicate directly with its device, but works through a lower-level kernel-mode driver. Sometimes this driver is device-specific and is provided by the device manufacturer. Sometimes its a generic Windows driver that simply provides communication services for USB devices, or SCSI devices. Sources are installed under the twain_32 folder under the Windows root folder usually in vendor or device sub-folder. They have an extension of .ds even though they are DLLs.

Page 143

EZTwain Pro User Guide

Datasource Manager (AKA DSM)

The common TWAIN module distributed by the TWAIN Working Group. This module, often called the DSM, is maintained by the members of the Working Group, and is provided in binary form to all TWAIN developers. It is customary for TWAIN devices to install/update the DSM when they install their individual TWAIN Sources and lowlevel drivers. The job of the DSM is to act as a go-between, coordinating and passing information between TWAIN applications and TWAIN Sources. Many users and developers assume that TWAIN (meaning the DSM) does some kind of serious processing or translation during scanning. This is not true. The DSMs jobs are simple: 1. Find and enumerate the installed Sources, display the Select Source dialog on request, and remember which DS is currently the default. 2. When an application issues an OPEN request, connect it with a Source. 3. Pass TWAIN operation requests from the application to the open DS, and pass notifications back to the application from the DS. All user interface, image processing, error handling, etc. etc. is divided between the application and the DS.

Default Datasource AKA Default TWAIN Device

To avoid applications asking users From which device? every time they want to acquire an image, TWAIN defines a default device. If there is only one TWAIN device installed in the system, then - thats it. Otherwise, it is the last TWAIN device selected by the user in the Select Source dialog. Which is the only bit of user interface provided by TWAIN itself, so to speak it is displayed by the TWAIN Source Manager.

Deskew
Scanning jargon meaning to straighten up. If you have done much scanning, you have probably noticed that some documents are scanned at a slight angle, This is called skew in the imaging industry. Some scanners, and many image software packages including EZTwain, can straighten out or deskew such tilted scans.

DIB (Device Independent Bitmap)

An image format defined and used by Windows EZTwain stores images in memory as DIBs. A DIB consists of a header giving height, width, bits per pixel, resolution, and so forth, followed by a color table if needed, followed by the pixels of the image. As an added complexity, the convention in Windows is to store DIBs in global memory blocks and work with the handles of these blocks which are not pointers. You will frequently see images referenced by objects of type HANDLE, or HGLOBAL or HDIB. As a consequence, to access the information in a DIB you must either lock the DIB handle to obtain a pointer, or call one of EZTwains many DIB functions (which lock and unlock the handle internally.)

Page 144

EZTwain Pro User Guide

FIX32 or TW_FIX32
A structure defined by TWAIN to represent fractional numeric values. It is a fixed point representation, a signed 32-bit integer with an implied binary point in the middle - i.e. 16 fractional bits. EZTwain includes various functions for working directly with FIX32 values, but for the most part EZTwain functions accept and return double (64-bit floating point) values and convert to FIX32 values internally.

GIF - Graphics Interchange Format

An image format originally defined by CompuServe. The version known as GIF 89a became ubiquitous on the World-Wide Web, although it was impaired by patent issues for many years. Once the patents expired, EZTwain adopted full support for GIF. It is typically used as an export format. GIF has a standard zip-like compression mode, and does well with line-art, text documents, and computergenerated images. It does very poorly at compressing grayscale and color images.

JFIF (JPEG File Interchange Format) File

Technically, the format commonly used to store JPEG-compressed images. Nobody officially maintains this format, despite its incredibly wide use. The definition is available for example at: http://www.w3.org/Graphics/JPEG/jfif3.pdf

JPEG (Joint Photographic Experts Group)

A standard form of compression for grayscale and color images. It is a lossy form of compression, because it discards some (hopefully less important) information from the original image, based on a model of the Human Visual System. The JPEG committee did not define a specific file format, so JFIF was defined see JFIF files. If you are seriously interested in JPEG compression, you can start here: http://old.jpeg.org/public/jpeghomepage.htm

PDF (Adobe Portable Document Format) File

A widely used format for public distribution of electronic documents, PDF can be used to store single-images or multiple pages. When writing to PDF, EZTwain stores 1-bit images losslessly, but uses lossy JPEG compression for grayscale and color images. See http://www.adobe.com/products/acrobat/main.html

PNG (Portable Network Graphics) File

A relatively new image file format designed to supercede GIF, particularly for World Wide Web graphics: PNG uses a lossless compression that does best on 1-bit B&W line-art (or text), where there are significant areas of identical color. PNG provides little compression for photographs and other imagery. See http://www.libpng.org/pub/png/ for all the details.

Resolution
In digital imaging and scanning, resolution is how finely a digital image divides up the physical world, commonly measured in dots per inch (DPI). DPI is commonly used, even in metric countries i.e. outside the USA. You will sometimes encounter the term samples as a more highbrow synonym for dots. Page 145

EZTwain Pro User Guide

If an image is 200 DPI this means the image contains 200 rows per vertical inch, and 200 columns per horizontal inch. Compared to a 100 DPI image, the 200 DPI image can distinguish a line or dot that is half as wide. The 200 DPI image also has 4 times as many pixels in it.

Thumbnail
A thumbnail is a small image - typically 32 to 64 pixels high, similar to an icon except that it is a low-resolution copy of the original that it represents.

TIFF (Tagged Image File Format) File

A complex, comprehensive image file format the dominant standard for highquality image interchange in graphic arts and publishing. See: The Unofficial TIFF Home Page at http://home.earthlink.net/~ritter/tiff/

Transfer Mode (AKA Transfer Mechanism AKA Xfer Mech)

TWAIN defines three ways for a TWAIN device (driver) to transfer image data to an application: 1. Native: In a single block in memory, formatted as a DIB (see above). 2. Memory: In a series of buffers, each holding part of the image. 3. File: As a file on disk. The file transfer mode is optional, and not all TWAIN devices support it. For most scanning applications, you should let EZTwain choose the transfer mode.

Triplet
Specialized TWAIN term: Every communication from an application to TWAIN consists of a triplet of codes plus a 32-bit datum. The functions TWAIN_DS and TWAIN_Mgr expose this bottom-level interface to TWAIN. Discussions of the TWAIN protocol often refer to sending triplets and the response to such-and-such triplet, and the core of the TWAIN Specification is the list of triplet definitions.

TWAIN
The Technology Without An Interesting Name. Actually TWAIN is not an acronym, which has caused endless confusion and frustration over the years. TWAIN is an industry-standard application programming interface (API) for applications to acquire images from imaging devices. It is only available on Microsoft Windows and Apple Macintosh. Familiar devices such as scanners, digital cameras, and webcams typically support TWAIN, as do some more exotic devices such as x-ray film scanners and digital microscopes. Almost all programs that can work with images support TWAIN image editors such as Photoshop, web design programs like Dreamweaver. The latest specification (at the time of this writing) is 1.9 See the TWAIN Specification

Page 146

EZTwain Pro User Guide

TWAIN Working Group

The informal organization that maintains the TWAIN Specification (Version 1.9 at the time of this writing) The specification and much other TWAIN information is available at www.twain.org

TWAIN Compliance
Compliance with the TWAIN standard is voluntary: TWAIN is not a trademark, and the TWAIN Working Group does not certify or enforce compliance of products. So, while it is wonderfully comprehensive and flexible, TWAIN is correspondingly burdened by its complexity, and a great amount of variation between devices. Almost every TWAIN compliant device can be shown to be non-compliant in some respect. EZTwain hides as much of this messiness as it can.

TWAIN States
TWAIN defines 7 states of a TWAIN conversation. Certain operations are only valid in certain states, and certain state transitions tell the Source, or the application, when they can get to work. Following are definitions of the 7 TWAIN States, please see the TWAIN Specification for the final, official word.

TWAIN State 1: TWAIN Not Loaded TWAIN State 2: Source Manager Loaded TWAIN State 3: Source Manager Open TWAIN State 4: DS Open
The Datasource is open but not enabled You can talk to it, and it has not initiated any image acquisition. You can negotiate with the DS to determine the parameters of image acquisition. All of the functions listed under Capability Negotiation can be called in State 4 The ones that set capabilities can only be safely called in State 4. You can read capabilities in State 4 or higher.

TWAIN State 5: DS Enabled

When the application enables the DS, it means go ahead with acquisition. In this state, the DS will normally display a dialog or user interface, allowing the user to tweak the controls and set the settings, and eventually, perhaps, click on the button labeled Scan, Capture, or whatever. If the DS is enabled without user interface, which most but not all DSs can do, then a proper DS will immediately begin acquiring an image, using the parameters negotiated in State 4.

TWAIN State 6: Transfer Ready

When an image is actually available and ready to transfer, the DS signals the application by posting a message, indicating that it is in State 6. In this state, the application must either cancel the transfer, or initiate transfer.

Page 147

EZTwain Pro User Guide

TWAIN State 7: Transfer In Progress

This is the State while image data is actively being transferred, and just after. The application is required to acknowledge the transfer, which moves the State to either 6 or 5, depending on whether another transfer is ready.

Page 148

EZTwain Pro User Guide

Appendix 1 - History
Note: There is more detailed history in the file History.txt, which is installed as part of the EZTwain Pro toolkit.

3.30
Changes / Corrections: New: Print... button in DIB_View/TWAIN_ViewFile dialog. Writing and Reading encrypted (password-protected) PDFs PDF_SetOpenPassword, PDF_SetUserPassword, PDF_SetOwnerPassword, PDF_SetPermissions / PDF_GetPermissions Writing PDF files that comply with PDF/A-1(b) - ISO 19005-1:2005 PDF_SetPDFACompliance / PDF_GetPDFACompliance. OCR_SetLineBreak DIB_LoadArrayFromBuffer DIB_LoadArrayFromFilename DIB_PageCountOfBuffer / DIB_BufferPageCount

3.20
Changes / Corrections: Recognize Window Vista Read yet another variant of TIFF from Kodak xCVS software. New: DIB_PrintFile/TWAIN_PrintFile (build 69) OCR functions using 3rd party Transym TOCR engine: OCR_IsAvailable, OCR_Version, OCR_IsEngineAvailable, OCR_SelectEngine, OCR_SelectDefaultEngine, OCR_SelectedEngine, OCR_EngineName, OCR_RecognizeDib, OCR_RecognizeDibZone (build 68), OCR_Text, OCR_GetText, OCR_TextLength, OCR_TextOrientation, OCR_GetCharPositions, OCR_GetCharSizes. OCR_WritePage, OCR_ClearText, OCR_SetEngineKey UPLOAD_FilesToURL, UPLOAD_MaxFiles, UPLOAD_AddHeader, UPLOAD_EnableProgressBar, UPLOAD_IsEnabledProgressBar (build 36) Functions to write text into PDF files: PDF_DrawText, PDF_SetTextVisible, PDF_DrawInvisibleText New aliases for existing functions: PDF_SetTitle, PDF_SetAuthor, PDF_SetSubject, PDF_SetKeywords, PDF_SetCreator, PDF_SetProducer. New post-processing mode: TWAIN_SetAutoOCR/TWAIN_GetAutoOCR TWAIN_FormatVersion (build 11) DIB_PhysicalWidth, DIB_PhysicalHeight (build 13) Support for Extended Image Info (build 14) TWAIN_IsExtendedInfoSupported TWAIN_EnableExtendedInfo TWAIN_IsExtendedInfoEnabled TWAIN_DisableExtendedInfo TWAIN_ExtendedInfoItemCount TWAIN_ExtendedInfoItemType TWAIN_ExtendedInfoInt TWAIN_ExtendedInfoFloat Page 149

EZTwain Pro User Guide

TWAIN_GetExtendedInfoString TWAIN_ExtendedInfoString TWAIN_GetExtendedInfoFrame BARCODE_TypeName (build 20) BARCODE_SetZone, BARCODE_NoZone (build 68) TWAIN_GetPaperDimensions (build 22) PDF_SelectPageSize (build 23) TWAIN_SingleMachineLicense (build 23) Definition of 'saturation' component changed slightly to give more intuitive (low) values for dark pixels (build 24) DIB_Avg (build 24) All file-writing functions create folders as needed (build 27) New installer (Inno Setup) with option to install shared DLLs only (build 27) TWAIN_IsMultipageFileOpen (build 41)

3.10
Changes / Corrections: Improved behavior of DIB_AutoContrast DIB_WriteRowChannel - Interpretation of nChannel parameter changed. Explicit message when license key is delivered too late in program execution. Functions that return Strings can now be called directly from Visual Basic. When writing a PDF to a memory buffer, no temp file is created on disk. New: UPLOAD_DibToURL, UPLOAD_DibsToURL, UPLOAD_DibsSeparatelyToURL UPLOAD_Response, UPLOAD_GetResponse, UPLOAD_IsAvailable, UPLOAD_Version, UPLOAD_AddFormField. Support for Black Ice barcode recognition engine (build 25) Support for LeadTools barcode recognition engine (build 28) BARCODE_ReadableCodes (build 28) TWAIN_Shutdown TWAIN_ReportLeaks DIB_ToImage (as an alias for DibToImage) in VB.NET DIB_WriteArrayToFilename DIB_WriteArrayToBuffer DIB_ReadRowChannel DIB_Resample DIB_DrawOnWindow DIB_DeskewAngle TWAIN_LogFileName TWAIN_SetBlankPageMode/TWAIN_GetBlankPageMode TWAIN_SetBlankPageThreshold/TWAIN_GetBlankPageThreshold TWAIN_SetAutoCrop/TWAIN_GetAutoCrop TWAIN_SetAutoContrast/TWAIN_GetAutoContrast DIB_SetViewOption/TWAIN_SetViewOption DIB_ViewClose/TWAIN_ViewClose DIB_IsViewOpen/TWAIN_IsViewOpen DIB_SetViewImage TWAIN_GetTiffTagAscii TWAIN_SetOutputPageCount, and improved TIFF Class F support.

Page 150

EZTwain Pro User Guide

3.09
Changes / Corrections: Many function parameters and return values that are Boolean (True or False) are now declared as booleans in languages where this is possible, particularly Delphi, Clarion, C#, and VB.NET. This may cause compile errors in existing code but they are easy and local to correct. DIB_LoadFromFilename, TWAIN_LoadNativeFromFilename, and DIB_GetFilePageCount all handle EZTwain-generated PDF files. DIB_Blt now converts source pixels to destination format as needed. DIB_Blt/DIB_RegionCopy: Several bugs for 1-bit B&W images are corrected. Statically linkable library EZT3MT.LIB added to toolkit. PDF files of ~7000 pages can now be written (previous limit was ~1000 pages) PDF files can be appended to! This is officially supported only for EZTwainwritten PDF files, contact Dosadi Support for other cases. (See TWAIN_SetFileAppendFlag/TWAIN_GetFileAppendFlag) Images with x-resolution different from y-resolution (faxes for example) are now displayed correctly and rendered to thumbnails correctly. Documentation added for DIB_SimpleThreshold, DIB_SmartThreshold New: BARCODE_IsAvailable BARCODE_Version BARCODE_Recognize BARCODE_IsEngineAvailable BARCODE_SelectEngine BARCODE_SelectedEngine BARCODE_SetDirectionFlags BARCODE_GetDirectionFlags BARCODE_AvailableDirectionFlags BARCODE_Text / BARCODE_GetText BARCODE_Type BARCODE_GetRect TWAIN_ExtensionFromFormat TWAIN_SetAutoDeskew, TWAIN_GetAutoDeskew TWAIN_LastOutputFile TWAIN_PagesInFile - same as DIB_GetFilePageCount, just easier to remember. TWAIN_SetTiffTagShort, TWAIN_SetTiffTagRational, TWAIN_SetTiffTagRationalArray, TWAIN_SetTiffTagBytes DIB_AutoDeskew - automatically deskew an image. DIB_GetCropRect - return the crop rectangle found by the AutoCrop algorithm. DIB_BitsPerSample, DIB_SamplesPerPixel - more image queries. DIB_IsVanilla, DIB_IsChocolate - queries about how black & white are coded. DIB_LoadFromBuffer, DIB_LoadPageFromBuffer, DIB_FormatOfBuffer functions that read an image from memory instead of from a disk file. DIB_WriteToBuffer - save an image into a memory buffer. DIB_AutoContrast (beta) - automatically adjust contrast of an image. DIB_Create - create an image of specified pixel type. DIB_SpecifyPrinter, DIB_EnumeratePrinters, DIB_GetPrinterName DIB_SetPrintFit/DIB_GetPrintToFit - control scale-to-fit during printing.

3.08
Corrected: Page 151

EZTwain Pro User Guide

The Trial License would sometimes not initialize, or would expire immediately. Incorrect declaration of several string-valued functions in .NET languages. New: TWAIN_SetCapability, TWAIN_SetCapString - for setting custom capabilities. TWAIN_SetTiffTagLong, TWAIN_SetTiffTagString, TWAIN_SetTiffTagDouble, TWAIN_ResetTiffTags - functions for setting specific tag values in TIFF files. TWAIN_SetPdfTitle, TWAIN_SetPdfAuthor, TWAIN_SetPdfSubject, TWAIN_SetPdfKeywords, TWAIN_SetPdfCreator, TWAIN_SetPdfProducer functions for setting specific summary (DID) fields in PDF files. TWAIN_SetAutoNegate/TWAIN_GetAutoNegate - control autonegate of excessively black scans. DIB_Thumbnail - creates a thumbnail of any image in memory. DIB_FromClipboard, DIB_CanGetFromClipboard - for implementing Paste. DIB_ComponentCopy - extract one channel from RGB or CMY(K) image. DIB_AdjustBC - change brightness and/or contrast of an image. DIB_ConvertToFormat - more general image format conversion, including conversions to and from 4-bit grayscale.

3.07
Corrected: With Visioneer Strobe XP450, 2nd and later pages blank or garbage - FIXED. CPU usage goes to 100% sometimes on 2nd batch - FIXED. Orientation tag in TIFF files correctly interpreted. New: Clarion binding. TWAIN_SetLogFolder TWAIN_OrganizationLicense (allowing embedded In-House App Licenses) TWAIN_ApplicationLicense TWAIN_ViewFile DIB_View DIB_ScaleToGray, DIB_Posterize, DIB_GetHistogram. DIB_Convolve, DIB_Correlate, DIB_CrossCorrelate, DIB_MedianFilter. DIB_Darkness DIB_PrintJobBegin, DIB_PrintJobEnd, DIB_PrintPage Streaming buffered memory transfers: TWAIN_BeginAcquireMemory, TWAIN_AcquireMemoryBlock, TWAIN_EndAcquireMemory. TWAIN_WaitForImage .tiff and .jpeg recognized as standard file extensions when saving files. PDF files now support indexed-color (palette color) images. PDF and JPEG files now support CMY/CMYK images. DCX multipage file support - .dcx extension recognized, DIB_WriteToDcx TWAIN_DoSettingsDialog. TWAIN_EnableSourceUiOnly TWAIN_GetCustomDataToFile, TWAIN_SetCustomDataFromFile TWAIN_SetImageReadyTimeout TWAIN_IsFileExtensionAvailable, TWAIN_FormatFromExtension TWAIN_SetGrayResponse, TWAIN_SetColorResponse TWAIN_ResetGrayResponse, TWAIN_ResetColorResponse TWAIN_SetCapBool CONTAINER_StringValue/CONTAINER_GetStringValue Page 152

EZTwain Pro User Guide

BARCODE_IsAvailable, BARCODE_Recognize, BARCODE_Text, BARCODE_GetText, BARCODE_Type, BARCODE_GetRect, BARCODE_SetDirectionFlags, BARCODE_GetDirectionFlags - (BETA) pass-thru to Axtel barcode engine.

3.06
Corrected: AcquireToFilename and Acquire were ignoring SetXferMech Conversion from RGB to 256-color made patches and sprays sometimes. DIB_RegionCopy wasnt copying DPI information. Distorted image when scanning native mode grayscale images to JPEG, with certain scanners New: Code Wizard. Reversed images from some scanners are detected and auto-reversed. TWAIN_SetRegion, TWAIN_ResetRegion. TWAIN_SetTiffImageDescription, TWAIN_SetTiffDocumentName. LZW compression enabled in TIFF files, for reading and writing. GIF now uses standard LZW compression (was using RLE.) DIB_DrawLine

3.05
Corrected: TWAIN_AcquireMultipageFile had a serious memory leak in the version 3.04! The C# and VB.NET wrappers have been improved. (StringBuilder result parameters were passed incorrectly ByRef.) Writing high-density images to TIFF could cause Rows Per Strip warning. New: Individual pages from a multipage TIFF file can now be loaded into memory using DIB_SelectPageToLoad, DIB_GetFilePageCount, DIB_LoadPage. Scans and images can now be appended to existing TIFF files, using TWAIN_SetFileAppendFlag/TWAIN_GetFileAppendFlag 16-bit grayscale and 48-bit RGB images can be scanned from capable scanners using TWAIN_AcquireMemory, and the resulting DIB can be saved in TIFF format at full depth. C# and VB.NET sample applications are included in the toolkit. TWAIN_SetPaperSize is much smarter and will produce the desired result on many more scanners. More detailed error codes are available from TWAIN_LastErrorCode, especially after a file read or write has failed. DIB_FormatOfFile/TWAIN_FormatOfFile.

3.04
Configuration change: EZMultipage.dll has been removed, code folded into EZTwain3.dll if you were redistributing this file, please delete it from your distribution. Corrected: DIB_DrawText had no effect on some systems. TIFF files were 'big-endian'. Page 153

EZTwain Pro User Guide

DIB_ToDibSection and DIB_ToPicture did not free the input DIB. New: TWAIN_MultipageCount DIB_ConvertToPixelType C# and VB.NET bindings Perl binding DIB_DrawText uses anti-aliasing in grayscale and RGB images. TWAIN_WriteToLog

3.03
3.03 was primarily a tune-up release: Reduced need to load EZTiff.dll, better error diagnosis when there is a licensing error, better logging to the logfile, and similar internal improvements. Corrected: A 'cancel' return from Enabling a device could cause an inappropriate error box. Some devices return 0 resolution in the transferred image - EZTwain now obtains the correct resolution using IMAGEINFO. New: JPEG compression as an option for TIFF files. Sometimes called JPEG-in-TIFF, this applies only to continuous-tone images in 8-bit grayscale and 24-bit RGB or CMYK. See TWAIN_Compression/TWAIN_GetTiffCompression for more details.

3.02
Corrected: PDF file scaling issues have been corrected PDF files are generated at true physical size if created from images that contain resolution (DPI) information. Bugs in the following functions: DIB_RegionCopy, DIB_Fill, DIB_Blt, DIB_ScaledCopy, DIB_DrawText. New: DIB_ToPicture and DIB_FromPicture (p. 47), specifically for VB developers. DIB_ToDibSection and DIB_FromBitmap (p. 45) which helps people working with the native Windows graphics API, and with Delphi TBitmaps, among others. TWAIN_SetTiffStripSize (p. 86) Special setting to help achieve TIFF compatibility with certain persnickity TIFF readers. TWAIN_SetTiffCompression (p. 89) To select from the various compression algorithms available when writing TIFF files.

Page 154

EZTwain Pro User Guide

Appendix 2 - Working with Containers

Theory
Containers are the currency of TWAIN settings. TWAIN devices have dozens, sometimes hundreds of properties that can be queried and set: Is there paper in the feeder, resolution to use for the next scan, the serial number of the device. TWAIN calls these properties capabilities, and capability values move back and forth between application and TWAIN device in packages called containers. TWAIN calls this exchange capability negotiation. Because it is necessary for the application and device to communicate not just the current value of a capability, but also its set of possible values, containers are quite rich and complex. Advisory: There is no way to talk about containers in TWAIN without introducing a lot of terms and concepts. Before reading the following, we recommend you open our Twirl TWAIN Probe, included in the EZTwain Pro toolkit. It can examine any TWAIN device on your computer and display its capabilities. You can select any capability and Twirl will describe the containers that are returned by that capability. Seeing how containers are actually used by your specific TWAIN device may make the following more comprehensible.

Page 155

EZTwain Pro User Guide

Containers come in four flavors, depending on what they need to represent: A OneValue container holds a single value, like: 200. Commonly used to select a specific value for a capability, such as 200 DPI for resolution, or to answer a simple query like CAP_FEEDERLOADED (is there paper in the feeder.) An Enumeration container is a set of values, with two values called out Current and Default. When queried with TWAIN_Get, many TWAIN capabilities return an Enumeration representing the set of valid values, plus the current value and the default (reset) value. A Range container describes a set of values by giving a minimum value, a maximum value, and an increment or step. Its like a for-loop. Like an Enumeration, the Range container can specify a Current value and a Default value. An Array container holds a list of values, none of which are special. Array containers are used with capabilities whose values are actually sets - like CAP_SUPPORTEDCAPS. All the items in a container are of the same basic item type, chosen from the following unecessarily baroque set. TWAIN Container Item Types Item Type TWTY_INT8 TWTY_INT16 TWTY_INT32 TWTY_UINT8 TWTY_UINT16 TWTY_UINT32 TWTY_BOOL TWTY_FIX32 TWTY_FRAME TWTY_STR32 TWTY_STR64 TWTY_STR128 TWTY_STR255 TWTY_STR1024 TWTY_UNI512 What each item holds 8-bit signed integer (-128..127) 16-bit signed integer (-32768..32767) 32-bit signed integer (go figure) 8-bit unsigned integer (0..255) 16-bit unsigned integer (0..65535) 32-bit unsigned integer (0.. 4294967295) TRUE (1) or FALSE (0) 32-bit fractional number about -32767.9999 to 32767.9999 a rectangle defined by 4 TWTY_FIX32 values 32-character ANSI string 64-character ANSI string 128-character ANSI string 255-character ANSI string 1024-character ANSI string 512-character UNICODE string

All these appear as defined constants in the EZTwain declaration file for your programming language. EZTwain tries to hide the details from you, but you should be aware that underneath, every container has a specific item type, and every capability has a specific item type that it works with.

Practice
EZTwain represents containers with a handle (a 32-bit integer) called an HCONTAINER. If you are coding in VB or similar, this is a 32-bit integer. Note: Because these are handles and not objects, you are responsible for releasing them when you are done with them, using CONTAINER_Free. The amount of Page 156

EZTwain Pro User Guide

memory involved is not as large as with images, but it is good practice to avoid leaks. The function TWAIN_Set (EZTwain.SetCap) is the fundamental function for sending a container to a capability. This function can only be called in TWAIN State 4, and will produce an error if called in any other state. TWAIN State 4 is the capability-setting state. TWAIN_Get (EZTwain.GetCap) is the core function for querying the value of a capability. The TWAIN State must be 4 or higher, or this function will produce an error. TWAIN_GetCurrent (EZTwain.GetCurrent) is used somewhat less often - it is supposed to return just the current value of a capability, but many TWAIN devices return the same container for both TWAIN_Get and TWAIN_GetCurrent.

Example 1. Enumerate Resolutions

Suppose you want to find out what resolutions a device supports. Assume the device is open from a previous call to TWAIN_OpenSource or TWAIN_OpenDefaultSource, so the device is in State 4. This is C/C++ code, the comments should help you translate to other languages:

Page 157

EZTwain Pro User Guide

// declare hcon as a 32-bit container handle HCONTAINER hcon; // Set the unit of measure to inches, because we want // resolution in samples per inch. In theory if current units // were cm, resolution would be returned in samples per cm! // (Dont count on that though, some devices always use DPI.) TWAIN_SetUnits(TWUN_INCHES); // We will use TWAIN_Get (EZTwain.GetCap) to get the // x-resolution capability value as a container. // You can assume that this container will list all allowed // (X) resolutions, plus the current and default resolution. hcon = TWAIN_Get(ICAP_XRESOLUTION); // Notice that TWAIN distinguishes X-resolution from Yresolution, // although they are normally the same sets of values, and // *usually* setting one will set the other to the same value. if (hcon != 0) { // It is mandatory for every TWAIN driver to support // ICAP_XRESOLUTION and ICAP_YRESOLUTION, so in this case // the check for valid hcon is pretty silly. If this // capability was optional, hcon = 0 would mean that the // capability is not supported. // Declare floating-point variables for resolution values: double dXRes, dXResCurrent, dXResDefault; dXResCurrent = CONTAINER_CurrentValue(hcon); dXResDefault = CONTAINER_DefaultValue(hcon); // Loop through all the supported values. // CONTAINER_ItemCount is always the number of values in hcon for (int i = 0; i < CONTAINER_ItemCount(hcon); i++) { // get the ith item in hcon, item 0 is the first: dXRes = CONTAINER_FloatValue(hcon, i); // do something with dXRes, like add to a listbox. } // end for CONTAINER_Free(hcon); // release the container } // Just for fun, reset X-resolution to default value: TWAIN_Reset(ICAP_XRESOLUTION);

Example 2. Custom Capability

For simple query/set situations, you may not need to use containers at all - you can usually use ETwains higher-level capability functions. TWAIN reserves the upper 32,768 capability codes for custom capabilities capabilities that are defined by the device vendor for a specific product or product family. There are only two ways to find out what these capabilities do - Ask the manufacturer, or experiment - for example, with Twirl. The Canon DR-2080C has a custom capability code hex 8025 (decimal 32805). Using Twirl we find that this capability uses type TWTY_INT32, and it returns an enumeration containing the values 2 and 0. By setting this capability through Twirl and enabling the device so its dialog pops up, we find that this capability controls the Page 158

EZTwain Pro User Guide

Automatic Border Removal feature: 2=enabled, 0=disabled. This is enough information for us to control this capability in our code, using the function TWAIN_SetCapability, which is specifically designed for setting custom capabilities:

// Try to enable Automatic Border Removal on DR-2080C: TWAIN_SetCapability(32805, 2);

Here is what this function is doing for you at a lower level:

// Declare a variable to hold a container handle (32-bit integer) HCONTAINER hcon // Create a one-value container of the correct type: hcon = CONTAINER_OneValue(TWTY_INT32, 2); // Try to set the Automatic Border Removal capability: TWAIN_Set(32805, hcon); // Dont leak memory: CONTAINER_Free(hcon);
To read the current value of this capability, you could use code like this:

// Declare a variable to hold a container handle (32-bit integer) HCONTAINER hcon // Get the container for the Automatic Border Removal capability: hcon = TWAIN_Get(32805); if (hcon != 0) { // valid container handle returned. // Test the current value represented by this container. // If its a Range or Enumeration, find the Current value // If its a OneValue, just use that (one) value: if (CONTAINER_CurrentValue(hcon) == 2) { ABRenabled = TRUE; } else { ABRenabled = FALSE; } CONTAINER_Free(hcon) }

Page 159

EZTwain Pro User Guide

Example 3. Endorser/Imprinter
Some scanners have an internal printer (called an imprinter or endorser) that can print something on each scanned page. There is wide variation in when, where, and what they print - before or after scanning, top, bottom, front, back, strings, serial numbers, etc. The TWAIN standard draws the following distinction: Imprinters are used to print data on documents at the time of scanning, and may be used for any purpose. Endorsers are more specific in nature, stamping some kind of proof of scanning on the document. TWAIN 1.9 p. 9-393 EZTwain does not include any functions specifically for controlling an imprinter or endorser, so you must roll your own from lower-level functions.

HCONTAINER hcon; // Get the list of available printer devices: hcon = TWAIN_Get(CAP_PRINTER); if (hcon == 0) return; // no printer available // Enumerate the available printer types: for (int i = 0; i < CONTAINER_ItemCount(hcon); i++) { // Look at each entry in the container, the TWAIN spec lists // the printer types under CAP_PRINTER: int PrinterType = CONTAINER_IntValue(hcon, i); } // end for CONTAINER_Free(hcon);
Here is code to enable the current printer (whatever type it is), and try to tell it to imprint on each page a string of the form Document-NNN-eztwain, with NNN starting at 640. Your scanner may not support this mode, of course.

// Enable the printer: TWAIN_SetCapBool(CAP_PRINTERENABLED, TRUE); // Tell printer to print a compound string (mode 2), // meaning <prefix-string><number><suffix-string> TWAIN_SetCapOneValue(CAP_PRINTERMODE, TWTY_UINT16, 2); // Tell printer to start serial numbers at 640: TWAIN_SetCapOneValue(CAP_PRINTERINDEX, TWTY_UINT32, 640); // Now, create a onevalue string (STR255) container, which // can be used to set both the prefix and suffix: hcon = CONTAINER_OneValue(TWTY_STR255, 0); // First set Document- as the containers one value: CONTAINER_SetItemString(hcon, 0, Document-); // Use that to set the (prefix?) printer string: TWAIN_Set(CAP_PRINTERSTRING, hcon); // The container still exists, change its value // to -eztwain, our suffix CONTAINER_SetItemString(hcon, 0, -eztwain); // Set the printers suffix string: TWAIN_Set(CAP_PRINTERSUFFIX, hcon); // Done with this container, dont leak memory. CONTAINER_Free(hcon);
Page 160

EZTwain Pro User Guide

Appendix 3 - Multithreading with EZTwain

It is possible to use EZTwain in a multithreaded program: Several customers have done this. You can follow the Simple Rule or the Complicated Rules. Simple Rule for Multithreading Make all EZTwain calls in one single thread, and if you pass a Window handle to EZTwain, it must belong to (have been created by) that thread. Complicated Rules for Multithreading 1. Once a call is made in thread T that moves the TWAIN State above State 2, all calls that require a State above State 2 must be made in thread T until the state drops to State 2 or lower. This includes all calls that change, or can change, the State, and all calls that set or query scanning capabilities or parameters. This includes: TWAIN_GetSourceList and TWAIN_(Get)NextSourceName. 2. Any window handle passed as a parameter to an EZTwain call from thread T must have been created in thread T. 3. DIB_ functions can be called in any thread, as long as they are given a valid DIB handle. This also applies to: TWAIN_WriteNativeToFilename, TWAIN_LoadNativeFromFilename TWAIN_BeginMultipageFile, TWAIN_DibWritePage, TWAIN_EndMultipageFile TWAIN_MultipageCount TWAIN_FormatOfFile. 4. CONTAINER_ functions can be called in any thread, as long as they are given a valid HCONTAINER. 5. Certain EZTwain global-state functions can be called in any thread, but EZTwain does not protect itself from race conditions. For example: TWAIN_State TWAIN_RegisterApp, TWAIN_SetAppTitle TWAIN_SetApplicationKey, TWAIN_SetVendorKey TWAIN_ApplicationLicense, TWAIN_OrganizationLicense TWAIN_SetHideUI / TWAIN_GetHideUI TWAIN_SetMultiTransfer / TWAIN_GetMultiTransfer TWAIN_SuppressErrorMessages TWAIN_IsMultipageAvailable, TWAIN_IsJpegAvailable, etc. TWAIN_FormatFromExtension TWAIN_SetFileAppendFlag / TWAIN_GetFileAppendFlag TWAIN_SetSaveFormat / TWAIN_GetSaveFormat TWAIN_SetMultipageFormat / TWAIN_GetMultipageFormat TWAIN_SetJpegQuality / TWAIN_GetJpegQuality TWAIN_SetTiff* / TWAIN_GetTiff* TWAIN_EasyVersion TWAIN_DisableParent / TWAIN_GetDisableParent

Page 161

EZTwain Pro User Guide

Appendix 4 - EZTwain Datatypes

EZTwain Datatypes C/C++ type void int unsigned double double* LPSTR char* LPCSTR LPVOID BYTE* LPMSG HANDLE HWND HCONTAINER BOOL HPALETTE HDC HFILE
(1)

physical representation used as a placeholder to mean nothing or no value 32-bit (4-byte) signed word 32-bit (4-byte) unsigned word. 64-bit (8-byte) IEEE binary floating number 32-bit pointer to a double. 32-bit pointer to 0-terminated string of 8-bit ANSI characters. same as LPSTR same as LPSTR but pointed-to string cannot be modified. 32-bit pointer, not specified to what. 32-bit pointer to a byte (usually used to point to a buffer of data.) 32-bit pointer to a Windows MSG structure. unsigned number, used to designate an object. HANDLE of a window. HANDLE to an EZTwain container object. 32-bit word either 0 (FALSE) or 1 (TRUE) HANDLE specifically for a Windows GDI palette. HANDLE of a Windows GDI Device Context. HANDLE of a Windows file, for CreateFile, Write, _lclose,

Note 1: In EZTwain, parameters declared as double* are used by the called function to return values. In Visual Basic these would be declared as ByRef parameters. If your language has the concept of reference parameter, you would translate double* as a parameter of type double passed by reference.

Page 163

EZTwain Pro User Guide

Index
16-bit grayscale............................29 48-bit color...................................29 A4 Letter (paper size)...................126 A5 (paper size)............................126 Access............................................. sample application........................3 access restrictions..........................95 Acrobat Reader..............................95 ADF.............................................16 anisotropic images.........................48 anti-aliasing..................................... in DIB_DrawText......................154 auto rotation.................................19 auto-OCR mode.............................34 autocontrast..................................... mode........................................33 autocontrast adjust........................59 autocrop.......................................... autocrop functions......................58 mode........................................33 autodeskew...................................... definition...................................58 mode........................................33 autonegate....................................... mode........................................34 averaging......................................... B&W to grayscale........................54 pixels in an image.......................60 B&W................................................ pixel type...........................40, 113 scanning..................................113 B4 (paper size)............................126 B5 Letter (paper size)...................126 barcode............................................ Axtel engine...............................68 Black Ice engine..................70, 150 detection in hardware..................37 direction flags............................71 engines.....................................68 LeadTools engine.................69, 150 native (Dosadi) engine...............68 recognition................................67 recommended book.....................67 symbology (definition)................67 types (symbologies)....................72 BARCODE_AvailableDirectionFlags. . .71 BARCODE_GetDirectionFlags...........71 BARCODE_GetRect.........................72 BARCODE_GetText.........................72 BARCODE_IsAvailable....................67 BARCODE_IsEngineAvailable...........68 BARCODE_NoZone.........................71 BARCODE_ReadableCodes.......70, 150 BARCODE_Recognize......................72 BARCODE_SelectedEngine..............68 BARCODE_SelectEngine..................68 BARCODE_SetDirectionFlags...........71 BARCODE_SetZone........................71 BARCODE_Text..............................72 BARCODE_Type.............................72 BARCODE_TypeName.....................70 blank pages...................................... DIB_IsBlank...............................60 discarding, example....................17 BMP.............................................78 Borland C++ Builder....................3, 6 brightness........................................ scanning..................................114 brightness & contrast......................... adjustment of an image...............51 C#.................................................3 sample application........................3 Canon DR-2080C.........................158 CAP_PRINTER..............................160 capability negotiation.....26, 113, 121, 147, 155 CCITT Group 4 Fax compression......78 Chocolate (chocolate pixels)..........138 Clarion................................3, 6, 152 clipboard......................................63 clipboard functions.........................63 CMY...............................40, 113, 152 CMYK....................................40, 113 code 39 barcode............................68 Code Wizard................................153 color table...........41, 43, 62, 113, 144 color table........................................ optimized..................................54 components...................................... extracting color components........61 files of EZTwain library..................2 of color table..............................43 (channels) of an image..........60, 61 compression................................145 compression..................................... in PDF files...........................86, 92 LZW - Unisys patent....................89 CONTAINER_Array.......................134 CONTAINER_ContainsValue.....30, 133 CONTAINER_CurrentIndex............133 Page 165

EZTwain Pro User Guide

CONTAINER_CurrentValue.....133, 159 CONTAINER_DefaultIndex.............133 CONTAINER_DefaultValue.............133 CONTAINER_DeleteItem...............135 CONTAINER_FindValue.................133 CONTAINER_FloatValue................133 CONTAINER_Format.....................132 CONTAINER_Free..................156, 159 CONTAINER_GetStringValue..........133 CONTAINER_IntValue...................133 CONTAINER_IsValid.....................132 CONTAINER_ItemCount..132, 134, 135 CONTAINER_ItemType..................132 CONTAINER_MaxValue.................133 CONTAINER_MinValue..................133 CONTAINER_OneValue..................159 CONTAINER_SelectCurrentItem.....134 CONTAINER_SelectCurrentValue....134 CONTAINER_SelectDefaultItem......134 CONTAINER_SelectDefaultValue.....134 CONTAINER_SetItem....................134 CONTAINER_StepSize...................133 CONTAINER_StringValue...............133 CONTAINER_TypeSize..................132 CONTAINER_ValuePtr...................133 containers...................................132 Array container.........................156 creating...................................134 Enumeration container.......134, 156 OneValue container............134, 156 Range container................134, 156 working with............................155 contrast........................................... adjustment, automatic................59 scanning..................................114 copying............................................ DIBs.........................................41 pixels........................................55 counting pages................................. after multipage acquire...............83 cropping........................................... an image...................................55 during scan..............................123 custom capabilities.......................158 custom capability.........................122 custom DS data...........................131 Custom TIFF tags...........................90 Daniel Stenberg.............................98 Data Source Manager...................144 dBASE........................................3, 6 DCX................1, 2, 26, 79, 80, 82, 84 automatic binarization...............142 DDB.............................................45 Page 166

debugging...........................108, 136 deep DIBs.....................................29 Default Datasource.................35, 144 default multipage format................82 default printer...............................65 Delphi........................................3, 5 deskew.......................................144 device context...............................57 Device Independent Bitmap...........144 DIB.........12, 25, 26, 29, 45, 143, 144 DIB................................................. allocating...................................41 comparison................................43 conversion.................................54 converting to HBITMAP................46 converting to Picture...................47 depth........................................40 drawing in with GDI....................57 freeing......................................41 handles..............................62, 144 reading from file.........................85 resolution.............................40, 41 rotation.....................................52 row access.................................42 scaling/resizing..........................53 writing to file........................81, 82 DIB_AdjustBC...............................51 DIB_Allocate.................................41 DIB_AutoContrast..........................59 DIB_AutoCrop...............................58 DIB_AutoDeskew...........................58 DIB_Avg.......................................60 DIB_AvgColumn............................60 DIB_AvgRegion.............................60 DIB_AvgRow.................................60 DIB_Blt........................................55 DIB_BltMask.................................55 DIB_CanGetFromClipboard......63, 152 DIB_CloseInDC..............................57 DIB_ColorCount.............................43 DIB_ColorTableB...........................43 DIB_ColorTableG...........................43 DIB_ColorTableR...........................43 DIB_ComponentCopy.....................61 DIB_ConvertToFormat.............54, 152 DIB_ConvertToPixelType.................54 DIB_Convolve..............................152 DIB_Copy.....................................41 DIB_Correlate..............................152 DIB_Create...................................41 DIB_CreatePalette.........................62 DIB_CrossCorrelate......................152 DIB_Darkness........................60, 152

EZTwain Pro User Guide

DIB_Depth....................................40 DIB_DeskewAngle..........................58 DIB_DrawLine.................51, 149, 153 DIB_DrawOnWindow......................44 DIB_DrawText...............................48 DIB_DrawToDC.............................44 DIB_EnumeratePrinters..................64 DIB_Equal....................................43 DIB_Fill........................................51 DIB_FlipHorizontal.........................51 DIB_FlipVertical.............................51 DIB_Free....................25, 29, 41, 142 DIB_FromBitmap...........................46 DIB_FromClipboard................63, 152 DIB_FromPicture...........................47 DIB_GetCropRect...........................58 DIB_GetFilePageCount...................84 DIB_GetFromClipboard...................63 DIB_GetHistogram..................60, 152 DIB_GetPrinterName......................64 DIB_GetPrintToFit..........................64 DIB_Height...................................40 DIB_IsBlank..................................60 DIB_IsViewOpen..........................104 DIB_LoadFromFilename............84, 85 DIB_LoadPage...............................85 DIB_Lock......................................62 DIB_MedianFilter....................59, 152 DIB_Negate..................................51 DIB_OpenInDC..............................57 DIB_PaintMask..............................56 DIB_PhysicalHeight........................41 DIB_PhysicalWidth.........................41 DIB_PixelType...............................40 DIB_Posterize..............................152 DIB_Print......................................65 DIB_PrinterName...........................64 DIB_PrintFile.................................65 DIB_PrintJobBegin..................66, 152 DIB_PrintJobEnd....................66, 152 DIB_PrintNoPrompt........................65 DIB_PrintPage........................66, 152 DIB_PutOnClipboard......................63 DIB_ReadRow...............................42 DIB_ReadRowChannel....................42 DIB_ReadRowGray.........................42 DIB_ReadRowRGB.........................42 DIB_RegionCopy............................55 DIB_Resample...............................53 DIB_Rotate180..............................52 DIB_Rotate90...............................52 DIB_RowBytes...............................41 DIB_ScaledCopy............................53

DIB_ScaleToGray...................54, 152 DIB_SelectPageToLoad...................84 DIB_SetColorCount........................62 DIB_SetColorTableRGB...................43 DIB_SetGrayColorTable..................43 DIB_SetPrintToFit..........................64 DIB_SetResolutionInt.....................41 DIB_SetTextAngle..........................49 DIB_SetTextColor..........................49 DIB_SetTextFace...........................49 DIB_SetTextFormat........................50 DIB_SetTextHeight........................48 DIB_SetViewImage......................104 DIB_SetViewOption......................106 DIB_SimpleThreshold.....................53 DIB_SmartThreshold...............53, 115 DIB_SpecifyPrinter.........................64 DIB_SwapRedBlue.........................62 DIB_Thumbnail.............................53 DIB_ToDibSection..........................46 DIB_ToImage................................46 DIB_ToPicture...............................47 DIB_Unlock...................................62 DIB_View............................104, 152 DIB_ViewClose............................105 DIB_Width....................................40 DIB_WriteArrayToFilename.............81 DIB_WriteRow...............................42 DIB_WriteRowChannel...................42 DIB_WriteToBmp.........................142 DIB_WriteToBuffer.........................81 DIB_WriteToDcx...................142, 152 DIB_WriteToFilename...............81, 88 DIB_WriteToGif............................142 DIB_WriteToJpeg.........................142 DIB_WriteToPdf...........................142 DIB_WriteToPng..........................142 DIB_WriteToTiff...........................142 DIB_XResolution............................40 DIB_YResolution............................40 DIBSection.........................45, 46, 57 DibToImage..................................46 digital still camera.........................15 displaying an image.....................104 document feeder....................16, 117 document information dictionary (DID) ................................................92 drawing a line...............................51 DS.............................................143 DSC................................................. see Digital Still Camera...............15 encryption....................................94 enumerating..................................... Page 167

EZTwain Pro User Guide

available printers........................64 barcode engines.........................67 OCR engines..............................75 Sources.....................................35 error diffusion...............................54 errors.............................................. reporting..........................107, 140 suppressing..............................107 Extended Image Information...........37 EZCurl.dll..................................2, 98 EZDcx.dll........................................2 EZGif.dll.........................................2 EZJpeg.dll......................................2 EZMultipage.dll............................153 EZPdf.dll........................................2 EZPng.dll........................................2 EZSymbol.dll.............................2, 68 EZT3MT.LIB................................3, 7 EZTiff.dll........................................2 EZTWAIN_Attach.............................7 EZTWAIN_Detach............................7 eztwain.log file............................108 Eztwain3.dll....................................2 fax file..........................................48 feeder.........................................117 file extension from format...............88 file format from extension...............88 file formats...1, 12, 14, 30, 78, 80, 86, 87, 88, 142, 143, 145 BMP........................................143 JFIF.........................................145 PDF.........................................145 PNG........................................145 TIFF........................................146 File Save dialog.............................81 File Transfer Mode.........................30 filling with solid color.....................51 FIX32.........................................145 Flate compression..........................79 flipping an image...........................51 form field......................................... when uploading..........................99 Foxit Reader..................................95 Frames.......................................134 frob............................................147 functions.......................................... barcode.....................................67 capability.................................121 clipboard...................................63 container...................121, 132, 135 deprecated...............................142 extended image info...................37 image acquisition........................24 Page 168

licensing....................................21 OCR..........................................74 PDF specific...............................92 post-processing..........................33 printing.....................................64 source (device) selection.............35 TIFF..........................................89 tone curves..............................129 TWAIN state.............................109 uploading..................................98 GDI+...........................................45 GIF..........................................2, 79 automatic quantization..............142 definition.................................145 Glossary.....................................143 grayscale......................................... converting to..............................54 HBITMAP.................................45, 46 HCONTAINER.......................156, 163 HDC.............................................46 hidden text...................................93 histogram.....................................60 History.txt......................................3 how to............................................. acquire an image........................12 append to TIFF & PDF files...........19 call EZTwain from other languages. 6 check for device on-line...............19 choose a file format....................78 control a feeder (ADF).................16 enumerate installed sources.........11 get started with EZTwain...............4 hide the scanner UI.....................15 negotiate scanning parameters.....13 obtain a License Key.....................9 redistribute EZTwain.....................8 scan a multipage document.........14 select a device for input...............10 skip blank pages.........................17 statically link to EZTwain...............7 use the Code Wizard.....................4 ICAP_AUTOBRIGHT......................116 ICAP_AUTOMATICROTATION...........19 ICAP_COMPRESSION....................138 ICAP_GAMMA..............................116 ICAP_HIGHLIGHT.........................116 ICAP_THRESHOLD........................115 IETF RFC 2301..............................91 image acquisition...........................24 image alignment (deskew)..............58 image analysis..............................60 Image class (.NET)........................45 image enhancement.......................58

EZTwain Pro User Guide

image files....................................... loading......................................84 image layout...............................123 image viewer options....................106 image viewer window...................104 image viewing.............................104 implementing paste......................63 imprinter step size.......................131 In-House Application License...........22 Index.........................................165 indexed-color.................................... in PDF files...............................152 indicators....................................120 Intelligent Character Recognition (ICR) ................................................74 item type....................................156 JavaScript ....................................94 JFIF files..........................80, 86, 145 JPEG......................1, 79, 80, 86, 145 JPEG compression............................. in TIFF files..........................86, 89 LabVIEW........................................6 libcurl library.................................98 license keys....................................8 using.........................................21 License.txt......................................3 licensing.......................................... In-House Application License........22 Universal Redistribution License. . .21 Licensing Wizard..........................3, 9 log file............................................. directory..................................108 turning on and off.....................108 writing to.................................108 Logitech QuickCam........................15 Lotus Notes....................................3 LotusScript.....................................6 low-level TWAIN functions.............140 LZW compression.........................153 masking.......................................55 media.............................................. reflective.................................116 median filter.................................59 Memory Transfer Mode............29, 138 message boxes................................. setting caption...........................21 metadata......................................... in PDF files................................92 Microsoft Access..............................6 Microsoft Visual C++.......................5 modeless.......................................... image viewer............................105 multipage.........................................

file viewing..............................104 file writing.................................82 scanning..............................26, 31 transfers....................................24 file page count..........................84 file reading...............................84 multithreading.................................. and static linking..........................7 how to multithread....................161 negating an image.........................51 OCR.............................................74 OCR Engine Codes.........................75 OCR_ClearText..............................77 OCR_EngineName..........................75 OCR_GetCharPositions....................77 OCR_GetCharSizes.........................77 OCR_GetText................................76 OCR_IsAvailable............................74 OCR_IsEngineAvailable...................75 OCR_RecognizeDib.........................76 OCR_RecognizeDibZone..................76 OCR_SelectDefaultEngine...............75 OCR_SelectedEngine......................75 OCR_SelectEngine.........................75 OCR_SetEngineKey........................75 OCR_SetLineBreak.........................75 OCR_Text.....................................76 OCR_TextLength............................76 OCR_TextOrientation......................77 OCR_Version.................................74 OCR_WritePage.............................77 OCR_WriteTextToPDF.....................77 Optical Character Recognition..........74 optional DLLs................................80 Organization License......................22 orientation of OCR'd text................77 owner password............................95 palettes..................................44, 62 paper dimensions.........................128 paper sizes..................................128 parent window.................................. disabling....................................32 Paste command.............................63 patch (barcode).............................67 PDF..............1, 2, 14, 26, 79, 84, 145 PDF................................................. JPEG compression.......................86 PDF Encryption..............................95 PDF Passwords..............................95 PDF_DrawInvisibleText...................93 PDF_DrawText...............................93 PDF_GetPDFACompliance................94 PDF_GetPermissions.......................97 Page 169

EZTwain Pro User Guide

PDF_SelectedPageSize....................93 PDF_SelectPageSize.......................93 PDF_SetAuthor..............................92 PDF_SetCompression.....................92 PDF_SetCreator.............................92 PDF_SetKeywords..........................92 PDF_SetOpenPassword...................96 PDF_SetOwnerPassword.................96 PDF_SetPDFACompliance................94 PDF_SetPermissions.......................97 PDF_SetProducer...........................92 PDF_SetSubject.............................92 PDF_SetTextVisible........................93 PDF_SetTitle.................................92 PDF_SetUserPassword....................96 PDF/A ISO 19005........................94 PDF/A compliance..........................94 Perl................................................6 Perl................................................. sample application........................3 using EZTwain from......................6 Picture object..........................45, 47 PictureBox....................................47 pixel flavor..................................138 pixel type..........13, 54, 112, 113, 115 pixel types....................................40 PNG..............................1, 2, 79, 145 Portable Document Format............145 Portable Network Graphics............145 position............................................ of image view window...............106 post-processing.............................33 auto OCR...................................34 auto-contrast.............................33 auto-crop...................................33 auto-negate...............................34 deskew......................................33 skip blank pages.........................33 PowerBASIC....................................6 PowerBuilder...................................3 print queue...................................65 print-to-fit flag..............................64 printer........................................160 printing........................................64 multipage..................................65 product name........................21, 137 Progress 4GL...............................3, 6 quality............................................. of JPEG compression...................86 radians.........................................58 random stuff..................................... how to do..................................19 RC4 encryption..............................95 Page 170

Readme.txt.....................................3 redistributing EZTwain.....................8 redistribution of the EZTwain DLLs.....9 region-of-interest (ROI).........123, 124 resampling....................................53 resolution................................13, 65 definition.................................145 loss by Picture objects.................47 of images..................................53 scanning...........................113, 114 rotation............................................ of text.......................................49 sample application............................ Microsoft Access...........................3 Perl.............................................3 VB.NET.......................................3 Save File dialog.............................25 scale-to-gray.................................54 scanning.......................................... duplex.....................................119 simplex...................................119 Select Source dialog...............10, 144 server response...........................102 settings dialog.............................130 shadow value..............................116 Single-Application Redistribution License........................................9 sizes of paper..............................128 skipping blank pages......................33 Source........................................143 Source Manager.............................31 standard BMP formats....................78 standard paper sizes....................128 state................................................ TWAIN States...........................147 State 1..........................24, 109, 147 State 2.........................109, 147, 161 State 3................................109, 147 State 4.....13, 24, 109, 110, 121, 124, 125, 131, 147, 157 State 5............26, 109, 110, 111, 147 State 6.........................109, 111, 147 State 7.........................109, 111, 148 state change...........31, 109, 110, 111 static link library.............................3 Streaming buffered memory transfers ..............................................152 strings........................................134 Sybase PowerBuilder........................5 symbol (barcode)...........................67 symbology (barcode)......................67 system default printer....................64 tacky default title...........................21

EZTwain Pro User Guide

Tagged Image File Format.............146 TBitmap (Delphi)...........................45 text................................................. annotation.................................48 text color......................................49 text height....................................48 text orientation.............................49 text orientation (OCR)....................77 text typeface.................................49 thresholding..........................54, 115 thumbnails....................................... creating.....................................53 definition.................................146 TIFF.........................1, 2, 14, 78, 146 TIFF................................................. 16-bit per channel......................29 appending to........................19, 86 Class F......................................91 compression modes....................89 for facsimile (fax).......................91 image description.......................89 JPEG compression.......................86 multipage..................................84 reading tags...............................91 setting tags................................90 standard....................................90 strip size...................................89 TOCR............................................... reseller version...........................75 TOCR (Transym) engine.................74 Transfer Mechanism.....................146 Transfer Mode.................30, 120, 146 Transym Computer Services Ltd......74 Triplet........................................146 TW_FIX32............................122, 139 TWAIN............................................. Compliance..............................147 Not an acronym........................146 States.....................................147 Working Group.........................147 TWAIN State..........................24, 109 TWAIN Working Group..................144 TWAIN_Acquire.............................25 TWAIN_AcquireCount.....................28 TWAIN_AcquireFile........................30 TWAIN_AcquireImagesToFiles.........27 TWAIN_AcquireMemory..................29 TWAIN_AcquireMemoryBlock.........152 TWAIN_AcquireMemoryCallback.....138 TWAIN_AcquireNative....................29 TWAIN_AcquireToClipboard.............30 TWAIN_AcquireToFilename.............25 TWAIN_ANYTYPE....................29, 120

TWAIN_ApplicationLicense..............21 TWAIN_AutoClickButton................137 TWAIN_BeginAcquireMemory.........152 TWAIN_BeginMultipageFile..............82 TWAIN_BlankDiscardCount.............28 TWAIN_Blocked...........................137 TWAIN_BuildName.......................137 TWAIN_BW...................................29 TWAIN_Compression....................138 TWAIN_DefaultSourceName............35 TWAIN_DibWritePage.....................82 TWAIN_DisableExtendedInfo...........37 TWAIN_DisableParent...................110 TWAIN_DoSettingsDialog.......130, 152 TWAIN_DS..................................146 TWAIN_EasyVersion.......................31 TWAIN_EnableDuplex...................119 TWAIN_EnableExtendedInfo............37 TWAIN_EnableSource...................110 TWAIN_EnableSourceUiOnly..........130 TWAIN_EndAcquireMemory...........152 TWAIN_EndMultipageFile................83 TWAIN_ErrorBox..........................108 TWAIN_ExtendedInfoFloat..............38 TWAIN_ExtendedInfoInt.................38 TWAIN_ExtendedInfoItemCount......38 TWAIN_ExtendedInfoItemType........38 TWAIN_ExtendedInfoString.............39 TWAIN_ExtensionFromFormat.........88 TWAIN_FormatFromExtension. .87, 152 TWAIN_FormatOfBuffer..................84 TWAIN_FormatOfFile......................84 TWAIN_FormatVersion...................87 TWAIN_Get..........................121, 157 TWAIN_GetAutoContrast.................33 TWAIN_GetAutoCrop......................33 TWAIN_GetAutoDeskew..................33 TWAIN_GetAutoNegate...................34 TWAIN_GetAutoOCR......................34 TWAIN_GetBitDepth.....................113 TWAIN_GetBlankPageMode.............33 TWAIN_GetBlankPageThreshold.......34 TWAIN_GetBuildName..................138 TWAIN_GetCapBool..............121, 130 TWAIN_GetCapCurrent.................139 TWAIN_GetCapUint16...................122 TWAIN_GetConditionCode.............108 TWAIN_GetCurrent...............121, 157 TWAIN_GetCurrentResolution........113 TWAIN_GetCurrentThreshold.........115 TWAIN_GetCurrentUnits...............124 TWAIN_GetCustomDataToFile 131, 152 TWAIN_GetDefault.......................121 Page 171

EZTwain Pro User Guide

TWAIN_GetDefaultImageLayout.....124 TWAIN_GetDefaultSourceName.......35 TWAIN_GetDuplexSupport............119 TWAIN_GetExtendedInfoFrame........39 TWAIN_GetExtendedInfoString........38 TWAIN_GetFileAppendFlag..............86 TWAIN_GetHideUI.........................31 TWAIN_GetImageLayout...............124 TWAIN_GetJpegQuality...................86 TWAIN_GetLastErrorText..............107 TWAIN_GetMultipageFormat...........32 TWAIN_GetMultiTransfer.................31 TWAIN_GetNextSourceName...........35 TWAIN_GetPaperDimensions.........128 TWAIN_GetResultCode.................107 TWAIN_GetSaveFormat..................88 TWAIN_GetSourceIdentity.............140 TWAIN_GetSourceName.................36 TWAIN_GetTiffCompression.............89 TWAIN_GetTiffStripSize..................89 TWAIN_GetTiffTagAscii...................91 TWAIN_GetYResolution.................113 TWAIN_GRAY................................29 TWAIN_HasFeeder.......................117 TWAIN_IsAutoFeedOn..................117 TWAIN_IsAvailable.........................31 TWAIN_IsDcxAvailable...................87 TWAIN_IsDuplexEnabled...............119 TWAIN_IsExtendedInfoEnable.........37 TWAIN_IsExtendedInfoSupported....37 TWAIN_IsFeederLoaded................117 TWAIN_IsFeederSelected..............117 TWAIN_IsFileExtensionAvailable.....87, 152 TWAIN_IsFormatAvailable...............87 TWAIN_IsGifAvailable.....................87 TWAIN_IsJpegAvailable..................87 TWAIN_IsMultipageFileOpen...........83 TWAIN_IsPdfAvailable....................87 TWAIN_IsPngAvailable...................87 TWAIN_IsTiffAvailable....................87 TWAIN_IsTransferReady...............140 TWAIN_IsViewOpen......................104 TWAIN_LastOutputFile....................88 TWAIN_LoadFromFilename.............84 TWAIN_LoadNativeFromFilename.....84 TWAIN_LoadSourceManager..........109 TWAIN_LogFile............................108 TWAIN_MessageHook............139, 140 TWAIN_Mgr.................................146 TWAIN_MultipageCount.....26, 83, 154 TWAIN_NegotiatePixelTypes..........120 TWAIN_NextSourceName................35 Page 172

TWAIN_OpenDefaultSource.............25 TWAIN_OpenSourceManager.........109 TWAIN_OrganizationLicense. . . .22, 152 TWAIN_PagesInFile........................84 TWAIN_PixelFlavor.......................138 TWAIN_PlanarChunky...................138 TWAIN_PrintFile............................65 TWAIN_Reset..............................121 TWAIN_ResetColorResponse...129, 152 TWAIN_ResetGrayResponse. . .129, 152 TWAIN_ResetImageLayout............124 TWAIN_ResetRegion.............123, 153 TWAIN_ResetTiffTags..............90, 152 TWAIN_RGB..................................29 TWAIN_SelectFeeder....................117 TWAIN_SelectImageSource.............35 TWAIN_SelfTest...........................136 TWAIN_Set..........................121, 157 TWAIN_SetApplicationKey...............21 TWAIN_SetAppTitle........................21 TWAIN_SetAutoContrast.................33 TWAIN_SetAutoCrop......................33 TWAIN_SetAutoDeskew..................33 TWAIN_SetAutoNegate...................34 TWAIN_SetAutoOCR.......................34 TWAIN_SetBitDepth.....................113 TWAIN_SetBlankPageMode.............33 TWAIN_SetBlankPageThreshold.......34 TWAIN_SetCapability.....122, 152, 159 TWAIN_SetCapBool...............122, 152 TWAIN_SetCapFix32R...................122 TWAIN_SetCapOneValue...............122 TWAIN_SetColorResponse......129, 152 TWAIN_SetCompression...............138 TWAIN_SetCurrentPixelType..........113 TWAIN_SetCustomDataFromFile. . .131, 152 TWAIN_SetFileAppendFlag..............86 TWAIN_SetFrame.................125, 126 TWAIN_SetGrayResponse......129, 152 TWAIN_SetHideUI....................26, 31 TWAIN_SetImageLayout........124, 126 TWAIN_SetImageReadyTimeout.....152 TWAIN_SetIndicators...................120 TWAIN_SetJpegQuality...................86 TWAIN_SetLogFolder.............108, 152 TWAIN_SetMultipageFormat............32 TWAIN_SetMultiTransfer..........31, 119 TWAIN_SetOutputPageCount...........83 TWAIN_SetPaperSize....................126 TWAIN_SetPixelFlavor..................138 TWAIN_SetPlanarChunky..............138 TWAIN_SetRegion.................123, 153

EZTwain Pro User Guide

TWAIN_SetResolution...................114 TWAIN_SetResolutionInt...............114 TWAIN_SetSaveFormat..................88 TWAIN_SetThreshold....................115 TWAIN_SetTiffCompression.............86 TWAIN_SetTiffDocumentName. 89, 153 TWAIN_SetTiffImageDescription.....89, 153 TWAIN_SetTiffStripSize..................89 TWAIN_SetTiffTagBytes..................90 TWAIN_SetTiffTagDouble.........90, 152 TWAIN_SetTiffTagLong............90, 152 TWAIN_SetTiffTagRational..............90 TWAIN_SetTiffTagRationalArray.......90 TWAIN_SetTiffTagShort..................90 TWAIN_SetTiffTagString..........90, 152 TWAIN_SetTiled...........................138 TWAIN_SetUnits...................112, 124 TWAIN_SetVendorKey....................21 TWAIN_SetViewOption..................106 TWAIN_SetXferCount...................112 TWAIN_SetXResolution.................114 TWAIN_SetYResolution.................114 TWAIN_SingleMachineLicense.........23 TWAIN_SourceName......................36 TWAIN_State.......................109, 110 TWAIN_SupportsFileXfer...............120 TWAIN_TiffTagAscii........................91 TWAIN_Tiled...............................138 TWAIN_ToFix32R.........................139 TWAIN_UserClosedSource.............137 TWAIN_ViewClose........................105 TWAIN_ViewFile...................104, 152 TWAIN_WaitForNativeXfer.............140 TWAIN_WriteToFilename................81 TWAIN_WriteToLog...............108, 154 TWAIN_XferMech.........................120 TWEI_ constants............................37 TWFF_BMP....................................80 TWFF_DCX....................................80 TWFF_GIF.....................................80 TWFF_JFIF....................................80 TWFF_PDF....................................80 TWFF_PNG....................................80 TWFF_TIFF....................................80 Twirl TWAIN Probe............3, 155, 158 TWPT_CMY....................................40 TWPT_CMYK..................................40 TWPT_GRAY..................................40 TWPT_PALETTE........................40, 54 TWPT_RGB....................................40 unit of measure.....112, 113, 114, 124 units..........................................112

Universal Redistribution License...9, 21 UPLOAD_AddFormField....99, 101, 150 UPLOAD_AddHeader.....................103 UPLOAD_ClearResponse................102 UPLOAD_DibsSeparatelyToURL......100 UPLOAD_EnableProgressBar..........103 UPLOAD_FilesToURL.....................100 UPLOAD_GetResponse..................102 UPLOAD_IsAvailable.......................98 UPLOAD_IsEnabledProgressBar......103 UPLOAD_MaxFiles..........................98 UPLOAD_Response.......................102 UPLOAD_ResponseLength.............102 UPLOAD_Version...........................98 uploading......................................... files.........................................100 form fields.................................99 functions...................................98 server response........................102 with HTTP-POST.........................98 US Legal (paper size)...................126 US Letter (paper size)..................126 user interface..............................147 user interface................................... hiding...14, 15, 16, 24, 31, 110, 120 user password...............................95 Vanilla (vanilla pixels)..................138 VB Picture objects..........................45 VB.NET...........................................4 VBA...........................................3, 6 version............................................ EZTwain history........................149 of file format module...................87 of OCR subsystem.......................74 of upload module........................98 Visual Basic.................................3, 4 Visual FoxPro..............................3, 5 webcams........................13, 143, 146 webcams.......................................... and multipage acquire.................26 using without UI.........................15 webserver.....................................98 Where to Put the DLLs......................8 windows........................................... drawing on................................44 XMP metadata...............................94 zones............................................... barcode...............................67, 71 OCR..........................................76 27 UPLOAD_DibsToURL ...................100 UPLOAD_DibToURL .....................100 .MPT............................................26 Page 173

EZTwain Pro User Guide

.NET Image object.........................46

Page 174