Click here to Skip to main content
11,416,531 members (56,031 online)
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

 
GeneralFix for windows 8.0 Pin
prcow12-May-14 12:24
memberprcow12-May-14 12:24 
GeneralRe: Fix for windows 8.0 Pin
smile869115-Dec-14 6:53
membersmile869115-Dec-14 6:53 
GeneralRe: Fix for windows 8.0 Pin
bidyut1234519-Jan-15 0:55
memberbidyut1234519-Jan-15 0:55 
QuestionTwain Driver Interface Dialog Pin
danajp_595-May-14 12:07
memberdanajp_595-May-14 12:07 
AnswerRe: Twain Driver Interface Dialog Pin
Ravishankar chinnur8-May-14 1:06
memberRavishankar chinnur8-May-14 1:06 
GeneralRe: Twain Driver Interface Dialog Pin
Imanol Pinto Lopez28-May-14 3:58
memberImanol Pinto Lopez28-May-14 3:58 
GeneralRe: Twain Driver Interface Dialog Pin
Imanol Pinto Lopez29-May-14 0:18
memberImanol Pinto Lopez29-May-14 0:18 
GeneralRe: Twain Driver Interface Dialog Pin
KB.Rajesh24-Feb-15 22:31
memberKB.Rajesh24-Feb-15 22:31 
GeneralRe: Twain Driver Interface Dialog Pin
KB.Rajesh24-Feb-15 22:29
memberKB.Rajesh24-Feb-15 22:29 
QuestionAbout disabling Scan Property form Pin
Member 107179417-Apr-14 3:22
memberMember 107179417-Apr-14 3:22 
AnswerRe: About disabling Scan Property form Pin
danajp_595-May-14 12:23
memberdanajp_595-May-14 12:23 
QuestionGreat Pin
magicyangjay18-Mar-14 22:50
membermagicyangjay18-Mar-14 22:50 
QuestionGet supported capabilities Pin
M.Azadi9-Mar-14 23:15
memberM.Azadi9-Mar-14 23:15 
QuestionWindows 8 errors with TwainLib.Twain.DSMident Pin
pserrao5-Mar-14 4:57
memberpserrao5-Mar-14 4:57 
AnswerRe: Windows 8 errors with TwainLib.Twain.DSMident Pin
Ravishankar chinnur5-Mar-14 19:12
memberRavishankar chinnur5-Mar-14 19:12 
GeneralRe: Windows 8 errors with TwainLib.Twain.DSMident Pin
pserrao6-Mar-14 10:37
memberpserrao6-Mar-14 10:37 
GeneralRe: Windows 8 errors with TwainLib.Twain.DSMident Pin
Ravishankar chinnur6-Mar-14 19:13
memberRavishankar chinnur6-Mar-14 19:13 
GeneralRe: Windows 8 errors with TwainLib.Twain.DSMident Pin
smile869115-Dec-14 6:54
membersmile869115-Dec-14 6:54 
Questionscanning one after another is not posiible Pin
Ravishankar chinnur5-Mar-14 3:08
memberRavishankar chinnur5-Mar-14 3:08 
AnswerRe: scanning one after another is not posiible Pin
malcolmxu21-Mar-14 6:54
membermalcolmxu21-Mar-14 6:54 
AnswerRe: scanning one after another is not posiible Pin
Antriksh Patel27-Jul-14 19:12
memberAntriksh Patel27-Jul-14 19:12 
BugInsufficient Memory Pin
keencoder20-Jan-14 23:42
memberkeencoder20-Jan-14 23:42 
GeneralRe: Insufficient Memory Pin
Member 1035479622-Sep-14 23:13
memberMember 1035479622-Sep-14 23:13 
QuestionHow to scan on both sides of the document Pin
sandeep7587-Jan-14 22:58
membersandeep7587-Jan-14 22:58 
Questionsave images Pin
ezelden.sahi12-Nov-13 22:30
memberezelden.sahi12-Nov-13 22:30 
QuestionHow can i change the transfer mode to File Pin
Murugan Kolanji11-Nov-13 3:43
memberMurugan Kolanji11-Nov-13 3:43 
GeneralThank you so much~! Pin
Cheon sang10-Nov-13 23:03
memberCheon sang10-Nov-13 23:03 
Question.NET TWAIN image scanner Convert to for VB 2010 Pin
Dibakar Mishra30-Oct-13 4:55
memberDibakar Mishra30-Oct-13 4:55 
QuestionGdipSaveImageToStream brings back a empty stream Pin
Member 391328323-Oct-13 9:49
memberMember 391328323-Oct-13 9:49 
GeneralMy vote of 5 Pin
Lucas Lima Araujo27-Sep-13 7:37
memberLucas Lima Araujo27-Sep-13 7:37 
QuestionWindows 8 Fails Pin
Lucas Lima Araujo27-Sep-13 5:39
memberLucas Lima Araujo27-Sep-13 5:39 
AnswerRe: Windows 8 Fails Pin
blastnsmash10-Dec-13 7:59
memberblastnsmash10-Dec-13 7:59 
GeneralRe: Windows 8 Fails Pin
smile869128-Jan-14 8:37
membersmile869128-Jan-14 8:37 
AnswerRe: Windows 8 Fails Pin
blastnsmash10-Dec-13 10:10
memberblastnsmash10-Dec-13 10:10 
Questionsave in Db Pin
partia3-Sep-13 4:16
memberpartia3-Sep-13 4:16 
AnswerRe: save in Db Pin
Windy Liu13-Sep-13 1:05
memberWindy Liu13-Sep-13 1:05 
This article shows how to scan and save images in database in .NET using a 3rd party sdk.
Scan and Save Images to a Database in C# Using Dynamic .NET TWAIN[^]

HTH
GeneralRe: save in Db Pin
partia20-Sep-13 4:31
memberpartia20-Sep-13 4:31 
GeneralRe: save in Db Pin
Windy Liu21-Sep-13 22:23
memberWindy Liu21-Sep-13 22:23 
QuestionPage rotation Pin
Ricardo Valero29-Aug-13 3:11
memberRicardo Valero29-Aug-13 3:11 
QuestionTWAIN Pin
Member 1018928525-Aug-13 17:33
memberMember 1018928525-Aug-13 17:33 
AnswerRe: TWAIN Pin
p312ry3-Dec-13 16:41
memberp312ry3-Dec-13 16:41 
Questionusing TWAIN Kyocera FS-1035 [modified] Pin
Member 998823614-Aug-13 1:48
memberMember 998823614-Aug-13 1:48 
QuestionPass parameters to without using ui Pin
saijagadeesh30-Jul-13 4:13
membersaijagadeesh30-Jul-13 4:13 
GeneralMy vote of 5 Pin
shiva_194-Jul-13 20:30
membershiva_194-Jul-13 20:30 
Questiontwain scanning in vb.net Pin
Dina_Du27-Jun-13 19:26
memberDina_Du27-Jun-13 19:26 
Questionc# n vb Pin
Imam Azinuddin19-Jun-13 20:14
memberImam Azinuddin19-Jun-13 20:14 
QuestionError in the Code Pin
Herman M. Reyes7-Jun-13 1:44
memberHerman M. Reyes7-Jun-13 1:44 
AnswerRe: Error in the Code Pin
Member 1015869416-Jul-13 11:14
memberMember 1015869416-Jul-13 11:14 
GeneralRe: Error in the Code Pin
Herman M. Reyes26-Jul-13 2:06
memberHerman M. Reyes26-Jul-13 2:06 
GeneralRe: Error in the Code Pin
Member 1020463311-Sep-13 10:19
memberMember 1020463311-Sep-13 10:19 

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
Web01 | 2.8.150427.4 | Last Updated 13 May 2002
Article Copyright 2001 by NETMaster
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid