Click here to Skip to main content
14,241,355 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

 
GeneralTransferring to Picturebox Pin
mazza19865-May-10 3:00
membermazza19865-May-10 3:00 
GeneralRe: Transferring to Picturebox Pin
Mlinux14-May-10 7:39
memberMlinux14-May-10 7:39 
GeneralRe: Transferring to Picturebox Pin
prcow17-Aug-10 6:43
memberprcow17-Aug-10 6:43 
QuestionUsing twain in dll Pin
Member 297511127-Apr-10 9:14
memberMember 297511127-Apr-10 9:14 
GeneralTHIS STUPID & FOOLISH CODE DOES NOT WORK Pin
Member 75098517-Apr-10 23:13
memberMember 75098517-Apr-10 23:13 
GeneralRe: THIS STUPID & FOOLISH CODE DOES NOT WORK Pin
elmocha19-Apr-10 19:41
memberelmocha19-Apr-10 19:41 
GeneralReading the capability parameter value Pin
sreevid16-Apr-10 9:13
membersreevid16-Apr-10 9:13 
QuestionHow to scan and show on picturebox vc# 2008 Pin
Supachai Prasertsit14-Apr-10 3:02
memberSupachai Prasertsit14-Apr-10 3:02 
Would you please recommand how to scan image to picturebox in vc# 2008. I need exam code.
AnswerRe: How to scan and show on picturebox vc# 2008 Pin
visatest14-Apr-10 15:15
groupvisatest14-Apr-10 15:15 
GeneralRe: How to scan and show on picturebox vc# 2008 Pin
Supachai Prasertsit14-Apr-10 19:03
memberSupachai Prasertsit14-Apr-10 19:03 
GeneralRe: How to scan and show on picturebox vc# 2008 Pin
strzata24-Jun-10 20:54
memberstrzata24-Jun-10 20:54 
GeneralRe: How to scan and show on picturebox vc# 2008 Pin
AmitSood198521-Jul-10 0:09
memberAmitSood198521-Jul-10 0:09 
GeneralRe: How to scan and show on picturebox vc# 2008 Pin
kosxxx9s15-Mar-11 4:59
memberkosxxx9s15-Mar-11 4:59 
GeneralRe: How to scan and show on picturebox vc# 2008 Pin
abdojawad23-Mar-11 12:04
memberabdojawad23-Mar-11 12:04 
GeneralRe: How to scan and show on picturebox vc# 2008 Pin
ishwer22-Mar-13 22:01
memberishwer22-Mar-13 22:01 
GeneralRe: How to scan and show on picturebox vc# 2010 Pin
ishwer22-Mar-13 22:02
memberishwer22-Mar-13 22:02 
AnswerRe: How to scan and show on picturebox vc# 2008 Pin
marcoscarrera21-Jun-11 19:46
membermarcoscarrera21-Jun-11 19:46 
QuestionHow can i return to multiple images when i using TWAIN API to scan images ? Pin
visatest11-Apr-10 15:23
groupvisatest11-Apr-10 15:23 
AnswerRe: How can i return to multiple images when i using TWAIN API to scan images ? Pin
Wolexie20-May-10 6:12
memberWolexie20-May-10 6:12 
GeneralTransfer Buffered Memory Mode ISSUE Pin
matheo7-Apr-10 3:19
membermatheo7-Apr-10 3:19 
GeneralRe: Transfer Buffered Memory Mode ISSUE Pin
fabioRGV4-Mar-11 0:22
memberfabioRGV4-Mar-11 0:22 
QuestionAbility to take a snapshot from a tv card video feed Pin
to_aru_shiroi_neko5-Apr-10 21:31
memberto_aru_shiroi_neko5-Apr-10 21:31 
AnswerRe: Ability to take a snapshot from a tv card video feed Pin
sirk123au31-Jul-10 15:58
membersirk123au31-Jul-10 15:58 
GeneralUse Twain DLL 64 bit Pin
Alessandro Test3-Mar-10 3:52
memberAlessandro Test3-Mar-10 3:52 
QuestionI converted this code for vb.net and got errors Pin
rheder28-Feb-10 15:24
memberrheder28-Feb-10 15:24 

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

6M views
118.8K downloads
415 bookmarked