Click here to Skip to main content
15,860,972 members
Articles / Programming Languages / C#
Article

.NET TWAIN image scanner

Rate me:
Please Sign up or sign in to vote.
4.91/5 (227 votes)
12 May 2002Public Domain2 min read 7.1M   132K   421   996
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:

C#
[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:

C#
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


Written By
Web Developer
Switzerland Switzerland
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
AnswerRe: can any one give this whole project in vb.net Pin
wellhi18-Nov-11 16:43
wellhi18-Nov-11 16:43 
QuestionAutocrop Pin
nsk_saravana13-Nov-11 22:21
nsk_saravana13-Nov-11 22:21 
QuestionRemoving Scanner UI Pin
nsk_saravana13-Nov-11 17:40
nsk_saravana13-Nov-11 17:40 
Questionremoving the UI Pin
mist99911-Nov-11 4:45
mist99911-Nov-11 4:45 
QuestionADF Question.....Help Me Pin
beyond111717-Oct-11 16:59
beyond111717-Oct-11 16:59 
QuestionCapture color image using twain Pin
akul12321-Sep-11 0:43
akul12321-Sep-11 0:43 
QuestionCould not compile Pin
ditoroin21-Sep-11 0:33
ditoroin21-Sep-11 0:33 
SuggestionRe: Could not compile Pin
MrPetan21-Sep-11 5:29
MrPetan21-Sep-11 5:29 
"BadImageFormatException" is thrown when the application loads a DLL having incompatible bitness
(a 64 bit exe tried to load a 32bit DLL or a 32 bit exe tried to load a 64 bit DLL).

Make sure you compile your exe file as 32 bit (x86) !!!!.


GeneralRe: Could not compile Pin
abdulhamyd23-Apr-12 22:59
abdulhamyd23-Apr-12 22:59 
QuestionCAP_DEVICEONLINE always returns false Pin
bennett cummins13-Sep-11 6:26
bennett cummins13-Sep-11 6:26 
Questionconverting this sample in asp.net Pin
akul12323-Aug-11 22:33
akul12323-Aug-11 22:33 
AnswerRe: converting this sample in asp.net Pin
Mandoleen22-Jan-12 21:22
Mandoleen22-Jan-12 21:22 
QuestionImage size Pin
VBCoder6818-Aug-11 5:14
VBCoder6818-Aug-11 5:14 
QuestionDont want dialog boxes Pin
Neha Ameen16-Aug-11 1:22
Neha Ameen16-Aug-11 1:22 
GeneralMy vote of 5 Pin
Shahin Khorshidnia12-Aug-11 19:50
professionalShahin Khorshidnia12-Aug-11 19:50 
QuestionADF is not working Pin
telme2-Aug-11 22:32
telme2-Aug-11 22:32 
AnswerRe: ADF is not working Pin
beyond111718-Oct-11 6:01
beyond111718-Oct-11 6:01 
GeneralRe: ADF is not working Pin
telme18-Oct-11 19:29
telme18-Oct-11 19:29 
QuestionIs it possible to do ADF and Flatbed Scanner in TWAIN Pin
telme30-Jul-11 23:27
telme30-Jul-11 23:27 
AnswerRe: Is it possible to do ADF and Flatbed Scanner in TWAIN Pin
beyond111718-Oct-11 6:03
beyond111718-Oct-11 6:03 
AnswerRe: Is it possible to do ADF and Flatbed Scanner in TWAIN Pin
Bala_Subramaniam11-Jan-12 0:01
Bala_Subramaniam11-Jan-12 0:01 
QuestionTwainLib.cs with full specification Pin
telme27-Jul-11 21:55
telme27-Jul-11 21:55 
QuestionRe: TwainLib.cs with full specification Pin
ben06068327-Jul-11 22:23
ben06068327-Jul-11 22:23 
QuestionSelecting ADF and Flatbed scanning option Pin
telme26-Jul-11 1:33
telme26-Jul-11 1:33 
QuestionDemo works but not the source Pin
Steven Szelei19-Jul-11 11:08
Steven Szelei19-Jul-11 11:08 

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.