Click here to Skip to main content
14,335,049 members

.NET TWAIN image scanner

Rate this:
4.91 (224 votes)
Please Sign up or sign in to vote.
4.91 (224 votes)
12 May 2002Public 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

 
AnswerRe: Help needed getting list of available scanners displayed in my own listbox and NOT via the Twain's GUI... Pin
Schnapple10-Mar-10 8:56
memberSchnapple10-Mar-10 8:56 
QuestionHelp need to select device from my own dropdownbox error--.Unable to cast object of type 'System.String' to type 'TwainLib.TwIdentity' Pin
jymitra13-Jul-10 20:28
memberjymitra13-Jul-10 20:28 
GeneralResolution and color Pin
AnandDegwekar9-Jan-10 3:43
memberAnandDegwekar9-Jan-10 3:43 
GeneralRe: Resolution and color Pin
Member 260553418-Jan-10 0:38
memberMember 260553418-Jan-10 0:38 
GeneralRe: Resolution and color Pin
AnandDegwekar18-Jan-10 5:25
memberAnandDegwekar18-Jan-10 5:25 
QuestionDirect Input of images Pin
AnandDegwekar4-Jan-10 23:14
memberAnandDegwekar4-Jan-10 23:14 
AnswerRe: Direct Input of images Pin
bgmeek7-Jan-10 5:12
memberbgmeek7-Jan-10 5:12 
GeneralRe: Direct Input of images Pin
AnandDegwekar8-Jan-10 7:19
memberAnandDegwekar8-Jan-10 7:19 
Thanks. That is exactly what i wanted. thank you once again.
GeneralDuplex Mode Pin
morke4-Jan-10 1:49
membermorke4-Jan-10 1:49 
Generaltwain_32.dll question Pin
DroneBG21-Dec-09 3:02
memberDroneBG21-Dec-09 3:02 
GeneralRe: twain_32.dll question Pin
NitinMakwana9-Feb-10 0:21
memberNitinMakwana9-Feb-10 0:21 
Generalthere's nothing un-modern or '16-bit' about TWAIN Pin
Spike0xFF18-Dec-09 14:33
memberSpike0xFF18-Dec-09 14:33 
Questionhow to save TWAIN Scanning image into pdf file Pin
Member 421353221-Nov-09 12:30
memberMember 421353221-Nov-09 12:30 
AnswerRe: how to save TWAIN Scanning image into pdf file Pin
AmitSood198520-Jul-10 23:58
memberAmitSood198520-Jul-10 23:58 
GeneralHello NetMaster Pin
Mike Kostersitz11-Nov-09 1:27
memberMike Kostersitz11-Nov-09 1:27 
Generali need the code with vb Pin
alaa9216111-Nov-09 23:54
memberalaa9216111-Nov-09 23:54 
QuestionHelp on Blank Page Detection Pin
geetesh.12331-Oct-09 2:30
membergeetesh.12331-Oct-09 2:30 
Questionnewbie question: mdi child form problem. Pin
dude25175418-Oct-09 18:49
memberdude25175418-Oct-09 18:49 
QuestionConnect to network scanner Pin
ihsan4u28-Sep-09 0:17
memberihsan4u28-Sep-09 0:17 
AnswerRe: Connect to network scanner Pin
James West1-Nov-09 12:08
memberJames West1-Nov-09 12:08 
AnswerEpson Supported Twain Commands Pin
JohnSims19421-Sep-09 1:07
memberJohnSims19421-Sep-09 1:07 
AnswerScanner with Document Feeder Pin
JohnSims19421-Sep-09 1:05
memberJohnSims19421-Sep-09 1:05 
GeneralRe: Scanner with Document Feeder Pin
Member 39132834-Nov-09 23:23
memberMember 39132834-Nov-09 23:23 
GeneralRe: Scanner with Document Feeder Pin
Member 39132834-Nov-09 23:35
memberMember 39132834-Nov-09 23:35 
AnswerRe: Scanner with Document Feeder Pin
JohnSims1944-Nov-09 23:50
memberJohnSims1944-Nov-09 23:50 

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.

Article
Posted 16 Sep 2001

Stats

6.1M views
120.1K downloads
416 bookmarked