Click here to Skip to main content
Click here to Skip to main content

.NET TWAIN image scanner

, 12 May 2002 Public Domain
Rate this:
Please Sign up or sign in to vote.
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

 
GeneralNo response after acquire(); Pinmemberkengct6-Nov-08 19:29 
RantRe: No response after acquire(); Pinmemberkengct13-Nov-08 0:46 
GeneralRe: No response after acquire(); Pinmemberhom_rcp25-Dec-08 5:45 
GeneralRe: No response after acquire(); Pinmemberkengct12-Jan-09 22:10 
GeneralRe: No response after acquire(); PinmemberJoey Burgett17-Mar-09 17:20 
Questionhow to scan image directly into picturebox instead of painting onto form? PinmemberJuraj Suchan16-Oct-08 12:13 
AnswerRe: how to scan image directly into picturebox instead of painting onto form? PinmemberGary Noter9-Dec-08 12:16 
GeneralRe: how to scan image directly into picturebox instead of painting onto form? PinmemberBurhan ERSOY28-Jul-09 23:52 
GeneralRe: how to scan image directly into picturebox instead of painting onto form? PinmemberGary Noter29-Jul-09 8:02 
GeneralSet duplex capability PinmemberSerenaFab15-Oct-08 1:50 
GeneralRe: Set duplex capability PinmemberDeiany20-Oct-08 5:01 
GeneralRe: Set duplex capability PinmemberRecycleYourLife10-Nov-08 11:27 
GeneralRe: Set duplex capability PinmemberRecycleYourLife11-Nov-08 5:05 
QuestionHow do I get TWON_RANGE values (TWAIN) ? Pinmembermuhtarqong10-Oct-08 11:15 
QuestionHow to get TWON_RANGE values? Pinmembermuhtarqong10-Oct-08 11:05 
AnswerRe: How to get TWON_RANGE values? [modified] PinmemberMember 216026519-Jan-11 18:20 
QuestionTwo Face PinmemberDCE_Erick3-Oct-08 9:08 
QuestionHow setting DAT_GRAYRESPONSE PinmemberMember 64259930-Sep-08 3:16 
GeneralBlack-Boxify the code please Pinmemberqjay11-Sep-08 11:17 
AnswerRe: Black-Boxify the code please PinmemberNETMaster11-Sep-08 13:00 
GeneralRe: Black-Boxify the code please Pinmemberqjay11-Sep-08 19:32 
QuestionHow can I check if I scan a blank document? Pinmemberjhonny24727-Aug-08 8:11 
AnswerRe: How can I check if I scan a blank document? PinmemberGary Noter9-Dec-08 12:50 
QuestionRe: How can I check if I scan a blank document? PinmemberNitinMakwana28-May-10 0:27 
AnswerChanging brightness PinmemberMember 463781224-Aug-08 11:41 
GeneralRe: Changing brightness PinmemberMember 260553418-Jan-10 1:36 
Questioncould you please give me an simple example for vb.net? Pinmemberbkkss20-Jul-08 17:29 
GeneralVS2008 x64 Vista Problem outside debugger... PinmemberTopper Price11-Jul-08 9:49 
GeneralRe: VS2008 x64 Vista Problem outside debugger... PinmemberTopper Price11-Jul-08 11:46 
Questionhow asp.net Pinmemberibulut3-Jul-08 0:12 
AnswerRe: how asp.net PinmemberGary Noter9-Dec-08 12:17 
Generalreturn TwainCommand.Not PinmemberMember 462883222-Jun-08 2:36 
GeneralRe: return TwainCommand.Not Pinmemberzedascoves9-Feb-11 4:10 
GeneralRe: return TwainCommand.Not PinmemberMember 833147720-Oct-11 4:08 
GeneralBad value by PixelType PinmemberMember 46378126-Jun-08 3:31 
QuestionVS2008 and Vista 64 bit Pinmembernxtwothou5-May-08 8:41 
AnswerRe: VS2008 and Vista 64 bit Pinmembernxtwothou5-May-08 10:51 
Questionhow to configure this lib(setting color,size,resolution???) PinmemberMember 447396622-Apr-08 2:02 
QuestionHow to set output size using twain capabilities? Pinmemberkantaiah13-Apr-08 20:14 
QuestionThis example doesn't work on VS2008 PinmemberMing_Z26-Feb-08 18:16 
AnswerRe: This example doesn't work on VS2008 PinmemberTopper Price11-Jul-08 9:57 
GeneralRe: This example doesn't work on VS2008 PinmemberMing_Z11-Jul-08 10:48 
GeneralScanner problem Pinmemberpiras10-Feb-08 8:35 
QuestionHow do I check if the scanner is plugged in Pinmemberpeter.goessweiner23-Jan-08 11:22 
AnswerRe: How do I check if the scanner is plugged in Pinmemberzahil5-Jun-08 19:57 
AnswerRe: How do I check if the scanner is plugged in Pinmembersptyangzhou16-Jul-08 4:58 
QuestionHow to set 100*100 Dpi without showing User Interface PinmemberMember 159761323-Jan-08 3:11 
AnswerRe: How to set 100*100 Dpi without showing User Interface Pinmemberzahil5-Jun-08 20:00 
GeneralResolution of saved image PinmemberZiggy Short17-Jan-08 6:33 
GeneralRe: Resolution of saved image [modified] PinmemberNeal175922-Jul-11 10:38 

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

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

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.141220.1 | Last Updated 13 May 2002
Article Copyright 2001 by NETMaster
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid