Click here to Skip to main content
14,328,233 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: How can I check if I scan a blank document? Pin
MacSpudster9-Dec-08 11:50
professionalMacSpudster9-Dec-08 11:50 
QuestionRe: How can I check if I scan a blank document? Pin
NitinMakwana27-May-10 23:27
memberNitinMakwana27-May-10 23:27 
AnswerChanging brightness Pin
mr_czech24-Aug-08 10:41
membermr_czech24-Aug-08 10:41 
GeneralRe: Changing brightness Pin
Member 260553418-Jan-10 0:36
memberMember 260553418-Jan-10 0:36 
Generalbug on cancel Pin
fabi____7-Aug-08 0:06
memberfabi____7-Aug-08 0:06 
AnswerRe: bug on cancel Pin
Member 350537014-Jan-09 12:05
memberMember 350537014-Jan-09 12:05 
Questioncould you please give me an simple example for vb.net? Pin
bkkss20-Jul-08 16:29
memberbkkss20-Jul-08 16:29 
GeneralVS2008 x64 Vista Problem outside debugger... Pin
Topper Price11-Jul-08 8:49
memberTopper Price11-Jul-08 8:49 
GeneralRe: VS2008 x64 Vista Problem outside debugger... Pin
Topper Price11-Jul-08 10:46
memberTopper Price11-Jul-08 10:46 
Questionhow asp.net Pin
ibulut2-Jul-08 23:12
memberibulut2-Jul-08 23:12 
AnswerRe: how asp.net Pin
MacSpudster9-Dec-08 11:17
professionalMacSpudster9-Dec-08 11:17 
Generalreturn TwainCommand.Not Pin
Member 462883222-Jun-08 1:36
memberMember 462883222-Jun-08 1:36 
GeneralRe: return TwainCommand.Not Pin
zedascoves9-Feb-11 3:10
memberzedascoves9-Feb-11 3:10 
GeneralRe: return TwainCommand.Not Pin
Member 833147720-Oct-11 3:08
memberMember 833147720-Oct-11 3:08 
GeneralBad value by PixelType Pin
mr_czech6-Jun-08 2:31
membermr_czech6-Jun-08 2:31 
QuestionVS2008 and Vista 64 bit Pin
nxtwothou5-May-08 7:41
membernxtwothou5-May-08 7:41 
AnswerRe: VS2008 and Vista 64 bit Pin
nxtwothou5-May-08 9:51
membernxtwothou5-May-08 9:51 
Questionhow to configure this lib(setting color,size,resolution???) Pin
salihovic22-Apr-08 1:02
membersalihovic22-Apr-08 1:02 
QuestionHow to set output size using twain capabilities? Pin
kantaiah13-Apr-08 19:14
memberkantaiah13-Apr-08 19:14 
QuestionThis example doesn't work on VS2008 Pin
Ming_Z26-Feb-08 17:16
memberMing_Z26-Feb-08 17:16 
AnswerRe: This example doesn't work on VS2008 Pin
Topper Price11-Jul-08 8:57
memberTopper Price11-Jul-08 8:57 
GeneralRe: This example doesn't work on VS2008 Pin
Ming_Z11-Jul-08 9:48
memberMing_Z11-Jul-08 9:48 
GeneralScanner problem Pin
piras10-Feb-08 7:35
memberpiras10-Feb-08 7:35 
QuestionHow do I check if the scanner is plugged in Pin
peter.goessweiner23-Jan-08 10:22
memberpeter.goessweiner23-Jan-08 10:22 
AnswerRe: How do I check if the scanner is plugged in Pin
zahil5-Jun-08 18:57
memberzahil5-Jun-08 18:57 

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
120K downloads
416 bookmarked