Click here to Skip to main content
14,216,244 members
Click here to Skip to main content
Article
Posted 16 Sep 2001

Stats

6M views
118.5K downloads
415 bookmarked

.NET TWAIN image scanner

,
Rate this:
4.91 (224 votes)
Please Sign up or sign in to vote.
4.91 (224 votes)
12 May 2002     Public Domain    
Using TWAIN API to scan images

Sample Screenshot

Abstract

In Windows imaging applications, the most used API for scanning is TWAIN www.twain.org. Unfortunately, the new .NET Framework has no built-in support for TWAIN. So we have to work with the interop methods of .NET to access this API. This article doesn't explain this interop techniques, and good knowledge of the TWAIN 1.9 specifications is assumed! The sample code included doesn't present a finished library, only some essential steps for a minimal TWAIN adaption to .NET applications.

Details

First step was to port the most important parts of TWAIN.H, these are found in TwainDefs.cs. The real logic for calling TWAIN is coded in the class Twain, in file TwainLib.cs.. As the TWAIN API is exposed by the Windows DLL, twain_32.dll, we have to use the .NET DllImport mechanism for interop with legacy code. This DLL has the central DSM_Entry(), ordinal #1 function exported as the entry point to TWAIN. This call has numerous parameters, and the last one is of variable type! It was found to be best if we declare multiple variants of the call like:

[DllImport("twain_32.dll", EntryPoint="#1")]
private static extern TwRC DSMparent(
    [In, Out] TwIdentity origin,
    IntPtr zeroptr,
    TwDG dg, TwDAT dat, TwMSG msg,
    ref IntPtr refptr );

The Twain class has a simple 5-step interface:

class Twain
{
    Init();
    Select();
    Acquire();
    PassMessage();
    TransferPictures();
}

For some sort of 'callbacks', TWAIN uses special Windows messages, and these must be caught from the application-message-loop. In .NET, the only way found was IMessageFilter.PreFilterMessage(), and this filter has to be activated with a call like Application.AddMessageFilter(). Within the filter method, we have to forward each message to Twain.PassMessage(), and we get a hint (enum TwainCommand) back for how we have to react.

Sample App

The sample is a Windows Forms MDI-style application. It has the two TWAIN-related menu items Select Source... and Acquire... Once an image is scanned in, we can save it to a file in any of the GDI+ supported file formats (BMP, GIF, TIFF, JPEG...)

Limitations

All code was only tested on Windows 2000SP2, with an Epson Perfection USB scanner and an Olympus digital photo camera. The scanned picture is (by TWAIN spec) a Windows DIB, and the sample code has VERY little checking against error return codes and bitmap formats. Unfortunately, no direct method is available in .NET to convert a DIB to the managed Bitmap class... Some known problems may show up with color palettes and menus.

Note, TWAIN has it's root in 16-Bit Windows! For a more modern API supported on Windows ME/XP, have a look at Windows Image Acquisition (WIA).

License

This article, along with any associated source code and files, is licensed under A Public Domain dedication

Share

About the Author

NETMaster
Web Developer
Switzerland Switzerland
No Biography provided

Comments and Discussions

 
QuestionRetrive a List of Paper Sizes Pin
bennett cummins15-Jul-11 10:19
memberbennett cummins15-Jul-11 10:19 
GeneralAccess Violation with Nikon Coolscan IV Pin
Easy_Rider999915-Jun-11 22:51
memberEasy_Rider999915-Jun-11 22:51 
Generalmessagefilter Pin
acep221-Jun-11 20:11
memberacep221-Jun-11 20:11 
GeneralSave each image Pin
Gabriel Perdigão1-Jun-11 7:42
memberGabriel Perdigão1-Jun-11 7:42 
GeneralRange value of capability ICAP_GAMMA Pin
Willzith Pham12-May-11 23:31
memberWillzith Pham12-May-11 23:31 
SuggestionRe: Range value of capability ICAP_GAMMA Pin
Spike0xFF14-Jul-11 12:05
memberSpike0xFF14-Jul-11 12:05 
GeneralHow to save all pages in 1 file [modified] Pin
LQUICK12-May-11 6:24
memberLQUICK12-May-11 6:24 
GeneralRe: How to save all pages in 1 file Pin
trpugh17-May-11 8:35
membertrpugh17-May-11 8:35 
I'm doing this using PDFSharp (http://www.pdfsharp.net/?AspxAutoDetectCookieSupport=1), which is a great library for working with PDFs. I'm saving each page to a file, and using PDFSharp to write a PDF with all images. Here's a code snippit:


PdfDocument pdf = new PdfDocument();

foreach (string bitmapFileName in bitmapFileNames)
{
PdfPage page = pdf.AddPage();

XGraphics gfx = XGraphics.FromPdfPage(page);

XImage img = XImage.FromFile(bitmapFileName);

gfx.DrawImage(img, new Rectangle(0, 0, (int)gfx.PageSize.Width, (int)gfx.PageSize.Height));
page.Close();
gfx.Dispose();
}
pdf.Save(pdfFileName);
bitmapFileNames.Clear();
GeneralCapability ICAP_GAMMA Pin
Willzith Pham11-May-11 23:45
memberWillzith Pham11-May-11 23:45 
General[TWAIN][CAPABILITES] Set float value for ICAP_GAMMA Pin
Willzith Pham11-May-11 16:58
memberWillzith Pham11-May-11 16:58 
GeneralHow obtain where image has been saved? Pin
mehdimax30-Apr-11 21:52
membermehdimax30-Apr-11 21:52 
QuestionHow to take picture from Digital Camera in C# application using TWAIN Pin
Member 77483387-Apr-11 20:08
memberMember 77483387-Apr-11 20:08 
QuestionFailed to save 600dpi color to BMP Pin
worship66829-Mar-11 7:45
memberworship66829-Mar-11 7:45 
GeneralHandling with the TW_ENTRYPOINT Pin
Tonkpils24-Mar-11 23:22
memberTonkpils24-Mar-11 23:22 
GeneralRe: Handling with the TW_ENTRYPOINT Pin
Easy_Rider999915-Jun-11 22:56
memberEasy_Rider999915-Jun-11 22:56 
GeneralRe: Handling with the TW_ENTRYPOINT Pin
Easy_Rider999915-Jun-11 22:58
memberEasy_Rider999915-Jun-11 22:58 
GeneralRe: Handling with the TW_ENTRYPOINT Pin
Tonkpils16-Jun-11 11:27
memberTonkpils16-Jun-11 11:27 
GeneralRe: Handling with the TW_ENTRYPOINT Pin
Easy_Rider999918-Jun-11 4:40
memberEasy_Rider999918-Jun-11 4:40 
QuestionHow to scan and show on picturebox vc# ?? Pin
abdojawad24-Mar-11 13:21
memberabdojawad24-Mar-11 13:21 
AnswerRe: How to scan and show on picturebox vc# ?? Pin
Easy_Rider999915-Jun-11 22:54
memberEasy_Rider999915-Jun-11 22:54 
GeneralScanner F2-6130 does not respond....:zzz: Pin
kosxxx9s16-Mar-11 10:07
memberkosxxx9s16-Mar-11 10:07 
AnswerRe: Scanner F2-6130 does not respond....:zzz: Pin
Member 14968626-Jun-11 22:32
memberMember 14968626-Jun-11 22:32 
Generalscanner window closes quickly Pin
Member 473569127-Feb-11 1:42
memberMember 473569127-Feb-11 1:42 
QuestionPDF format for image Pin
Member 770345524-Feb-11 18:29
memberMember 770345524-Feb-11 18:29 
AnswerRe: PDF format for image Pin
Gagan_198428-Feb-11 6:33
memberGagan_198428-Feb-11 6:33 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Layout: fixed | fluid

Article Copyright 2001 by NETMaster
Everything else Copyright © CodeProject, 1999-2019

Server Web01
Version 2.8.190619.2