Click here to Skip to main content
12,444,517 members (52,391 online)
Click here to Skip to main content
Add your own
alternative version

Stats

3.5M views
96.9K downloads
408 bookmarked
Posted

.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

You may also be interested in...

Pro
Pro

Comments and Discussions

 
QuestionError System.AccessViolationException Windows 10 64bit Pin
Imran Abbas Khawaja28-Jul-16 21:05
memberImran Abbas Khawaja28-Jul-16 21:05 
QuestionHow to set duplex scanning option as true Pin
MuzzyB19-Jul-16 22:58
memberMuzzyB19-Jul-16 22:58 
AnswerRe: How to set duplex scanning option as true Pin
MuzzyB21-Jul-16 1:11
memberMuzzyB21-Jul-16 1:11 
QuestionHow I can select the active scanner Pin
Osama Abu Sitta18-Jul-16 2:33
memberOsama Abu Sitta18-Jul-16 2:33 
AnswerRe: How I can select the active scanner Pin
MuzzyB19-Jul-16 22:48
memberMuzzyB19-Jul-16 22:48 
GeneralRe: How I can select the active scanner Pin
Osama Abu Sitta20-Jul-16 0:29
memberOsama Abu Sitta20-Jul-16 0:29 
GeneralRe: How I can select the active scanner Pin
MuzzyB20-Jul-16 2:26
memberMuzzyB20-Jul-16 2:26 
QuestionTwRC rc = DSMparent(appid, IntPtr.Zero, TwDG.Control, TwDAT.Parent, TwMSG.OpenDSM, ref hwndp); Pin
Salahov23-Jun-16 13:04
memberSalahov23-Jun-16 13:04 
QuestionGetting this error.An attempt was made to load a program with an incorrect format. (Exception from HRESULT: 0x8007000B) Pin
Nishant28521-Mar-16 2:29
memberNishant28521-Mar-16 2:29 
AnswerRe: Getting this error.An attempt was made to load a program with an incorrect format. (Exception from HRESULT: 0x8007000B) Pin
Member 1242837131-Mar-16 11:46
memberMember 1242837131-Mar-16 11:46 
QuestionVery Nice Work. Pin
vinod bagale24-Feb-16 0:36
membervinod bagale24-Feb-16 0:36 
AnswerRe: Very Nice Work. Pin
Nishant28521-Mar-16 2:30
memberNishant28521-Mar-16 2:30 
Questionhow to add multiple images in picturebox in 1 (one) form Pin
gunduzcagri20-Jan-16 4:16
membergunduzcagri20-Jan-16 4:16 
QuestionScanner hangs Pin
Helen Goussarova1-Dec-15 10:46
memberHelen Goussarova1-Dec-15 10:46 
AnswerRe: Scanner hangs Pin
smile86913-Dec-15 4:33
membersmile86913-Dec-15 4:33 
GeneralRe: Scanner hangs Pin
Helen Goussarova4-Dec-15 4:36
memberHelen Goussarova4-Dec-15 4:36 
QuestionSet Scanner settings Pin
Member 120525027-Nov-15 14:40
memberMember 120525027-Nov-15 14:40 
QuestionBadImageFormatException was unhandled Pin
m.tahsildari31-Aug-15 22:35
memberm.tahsildari31-Aug-15 22:35 
AnswerRe: BadImageFormatException was unhandled Pin
icode_chan1-Sep-15 21:46
membericode_chan1-Sep-15 21:46 
QuestionScanner Pin
Member 1186511026-Jul-15 20:51
memberMember 1186511026-Jul-15 20:51 
QuestionNOT CONNECTED TO SCANNER Pin
Member 1133752219-Jul-15 18:00
memberMember 1133752219-Jul-15 18:00 
QuestionDsiable Feed Pin
Member 1029469617-Jun-15 0:26
memberMember 1029469617-Jun-15 0:26 
QuestionScanner gets stuck "Scanning" Pin
eqiz16-Jun-15 13:55
membereqiz16-Jun-15 13:55 
AnswerRe: Scanner gets stuck "Scanning" Pin
eqiz17-Jun-15 11:10
membereqiz17-Jun-15 11:10 
QuestionHow to zoom? Pin
Member 116384986-Jun-15 21:40
memberMember 116384986-Jun-15 21:40 

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.

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