Click here to Skip to main content
14,768,114 members
Articles » Platforms, Frameworks & Libraries » Windows API » Graphics
Tip/Trick
Posted 4 Jul 2014

Stats

151.7K views
37.2K downloads
34 bookmarked

WIA Scanner in C# Windows Forms

Rate me:
Please Sign up or sign in to vote.
5.00/5 (18 votes)
4 Jul 2014CPOL
How to use WIA supported scanner using C#

Image 1

Introduction

This project is used to show how to use WIA Windows Image Acquisition supported Scanner. Using this project, we can scan applications from scanner and save into specific location automatically.

Background

With this project, we can learn how we can Access Scanners through C#. For this project, we need two things:

  1. WIA DLL
  2. WIA class

WIA dll is available in my resource file.

You can add this WIA class and there is no need to change anything.

class WIAScanner
    {
        const string wiaFormatBMP = "{B96B3CAB-0728-11D3-9D7B-0000F81EF32E}";
        class WIA_DPS_DOCUMENT_HANDLING_SELECT
        {
            public const uint FEEDER = 0x00000001;
            public const uint FLATBED = 0x00000002;
        }
        class WIA_DPS_DOCUMENT_HANDLING_STATUS
        {
            public const uint FEED_READY = 0x00000001;
        }
        class WIA_PROPERTIES
        { 
            public const uint WIA_RESERVED_FOR_NEW_PROPS = 1024;
            public const uint WIA_DIP_FIRST = 2;
            public const uint WIA_DPA_FIRST = WIA_DIP_FIRST + WIA_RESERVED_FOR_NEW_PROPS;
            public const uint WIA_DPC_FIRST = WIA_DPA_FIRST + WIA_RESERVED_FOR_NEW_PROPS;
            //
            // Scanner only device properties (DPS)
            //
            public const uint WIA_DPS_FIRST = WIA_DPC_FIRST + WIA_RESERVED_FOR_NEW_PROPS;
            public const uint WIA_DPS_DOCUMENT_HANDLING_STATUS = WIA_DPS_FIRST + 13;
            public const uint WIA_DPS_DOCUMENT_HANDLING_SELECT = WIA_DPS_FIRST + 14;
        }
         /// <summary>
        /// Use scanner to scan an image (with user selecting the scanner from a dialog).
        /// </summary>
        /// <returns>Scanned images.</returns>
        public static List<Image> Scan()
        {
            WIA.ICommonDialog dialog = new WIA.CommonDialog();
            WIA.Device device = dialog.ShowSelectDevice
                (WIA.WiaDeviceType.UnspecifiedDeviceType, true, false);
            if (device != null)
            {
                return Scan(device.DeviceID);
            }
            else
            {
                throw new Exception("You must select a device for scanning.");
            }
        }
        /// <summary>
        /// Use scanner to scan an image (scanner is selected by its unique id).
        /// </summary>
        /// <param name="scannerName"></param>
        /// <returns>Scanned images.</returns>
      public static List<Image> Scan(string scannerId)
        {
            List<Image> images = new List<Image>();
            bool hasMorePages = true;
            while (hasMorePages)
            {
                // select the correct scanner using the provided scannerId parameter
                WIA.DeviceManager manager = new WIA.DeviceManager();
                WIA.Device device = null;
                foreach (WIA.DeviceInfo info in manager.DeviceInfos)
                {
                    if (info.DeviceID == scannerId)
                    {
                        // connect to scanner
                        device = info.Connect();
                        break;
                    }
                }
                // device was not found
                if (device == null)
                {
                    // enumerate available devices
                    string availableDevices = "";
                    foreach (WIA.DeviceInfo info in manager.DeviceInfos)
                    {
                        availableDevices += info.DeviceID + "\n";
                    }
                    // show error with available devices
                    throw new Exception("The device with provided ID could not be found. 
                    Available Devices:\n" + availableDevices);
                }
                WIA.Item item = device.Items[1] as WIA.Item;
                try
                {
                    // scan image
                    WIA.ICommonDialog wiaCommonDialog = new WIA.CommonDialog();
        WIA.ImageFile image = (WIA.ImageFile)wiaCommonDialog.ShowTransfer(item,wiaFormatBMP                                                                           , false);
                      // save to temp file
                    string fileName = Path.GetTempFileName();
                    File.Delete(fileName);
                    image.SaveFile(fileName);
                    image = null;
                    // add file to output list
                    images.Add(Image.FromFile(fileName));
                }
                catch (Exception exc)
                {
                    throw exc;
                }
                finally
                {
                    item = null;
                    //determine if there are any more pages waiting
                    WIA.Property documentHandlingSelect = null;
                    WIA.Property documentHandlingStatus = null;
                    foreach (WIA.Property prop in device.Properties)
                    {
                    if (prop.PropertyID == WIA_PROPERTIES.WIA_DPS_DOCUMENT_HANDLING_SELECT)
                            documentHandlingSelect = prop;
                    if (prop.PropertyID == WIA_PROPERTIES.WIA_DPS_DOCUMENT_HANDLING_STATUS)
                            documentHandlingStatus = prop;
                    }
                    // assume there are no more pages
                    hasMorePages = false;
                    // may not exist on flatbed scanner but required for feeder
                    if (documentHandlingSelect != null)
                    {
                        // check for document feeder
                        if ((Convert.ToUInt32(documentHandlingSelect.get_Value()) & 
                        WIA_DPS_DOCUMENT_HANDLING_SELECT.FEEDER) != 0)
                        {
                            hasMorePages = ((Convert.ToUInt32(documentHandlingStatus.get_Value()) & 
                            WIA_DPS_DOCUMENT_HANDLING_STATUS.FEED_READY) != 0);
                        }
                    }
                }
            }
            return images;
        }
        /// <summary>
        /// Gets the list of available WIA devices.
        /// </summary>
        /// <returns></returns>
        public static List<string> GetDevices()
        {
            List<string> devices = new List<string>();
            WIA.DeviceManager manager = new WIA.DeviceManager();
            foreach (WIA.DeviceInfo info in manager.DeviceInfos)
            {
                devices.Add(info.DeviceID);
            }
            return devices;
        }
    }

Using the Code

I have created a UserInterface design like this:

Image 2

Here Scan button is used to trigger the event to scan the objects placed in Scanner. I have used panel control to show scanned image.

After scanning the object placed in Scanner device, the UI will be like this:

Image 3

Image 4

Here, I have saved scanned image into specific location with yyyy-MM-dd HHmmss format.

Points of Interest

With this project, we can learn how to access local devices like printers, scanners and cameras.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Chakravarthi Elchuri
Software Developer
India India
Having good experience of developing code for CTI, Scanner, Cammera, Interactive maps for IRP(International Registration Plan)integration and 311 service request maps using different Geocoding API providers.

Comments and Discussions

 
GeneralMy vote of 5 Pin
Deniz Akin20-Jan-21 9:04
MemberDeniz Akin20-Jan-21 9:04 
QuestionAlways return true when hasmorepage is validated Pin
Edson Nieto9-Jul-19 5:10
MemberEdson Nieto9-Jul-19 5:10 
QuestionScan the image connected the mobile device Pin
Member 138907957-Dec-18 22:46
MemberMember 138907957-Dec-18 22:46 
QuestionHelp me, please Pin
__Radik__21-Nov-17 1:46
Member__Radik__21-Nov-17 1:46 
QuestionChange Height and Width Pin
Member 1295166521-Nov-17 0:31
MemberMember 1295166521-Nov-17 0:31 
QuestionHow to ADF? Pin
Member 1239823712-Sep-17 2:51
MemberMember 1239823712-Sep-17 2:51 
Questionappear error message you dont have any WAI device Pin
Member 1246467625-Apr-17 0:00
MemberMember 1246467625-Apr-17 0:00 
QuestionHow to save to a specific location? Pin
alfred angkasa2-Nov-16 16:36
Memberalfred angkasa2-Nov-16 16:36 
QuestionThanks for this useful information Pin
Member 999352020-Aug-16 1:33
MemberMember 999352020-Aug-16 1:33 
QuestionHow to set the alternate light source Pin
Wolfgang Kurz23-Jun-16 23:07
professionalWolfgang Kurz23-Jun-16 23:07 
Question[Solved] How to get the human readable name of a selected WIA scanner Pin
Wolfgang Kurz22-Jun-16 3:54
professionalWolfgang Kurz22-Jun-16 3:54 
QuestionHow to change DPI or size? Pin
Boris Brock1-Feb-16 7:23
MemberBoris Brock1-Feb-16 7:23 
QuestionHow i increase scan image width. When i scan image it comming 50% only ? Pin
aarif moh shaikh4-Dec-15 0:13
professionalaarif moh shaikh4-Dec-15 0:13 
AnswerRe: How i increase scan image width. When i scan image it comming 50% only ? Pin
Member 1295166521-Nov-17 0:35
MemberMember 1295166521-Nov-17 0:35 
QuestionUsing WIA to capture Image from camera Pin
ahmedfaruk8817-Nov-15 2:23
Memberahmedfaruk8817-Nov-15 2:23 
QuestionHow to duplex scanning ? Pin
thucap23-Oct-15 0:59
Memberthucap23-Oct-15 0:59 
BugHRESULT E_FAIL Pin
Member 117521108-Jun-15 23:16
MemberMember 117521108-Jun-15 23:16 
GeneralRe: HRESULT E_FAIL Pin
Member 117521108-Jun-15 23:29
MemberMember 117521108-Jun-15 23:29 
Question"HRESULT: 0x80210003" Pin
Marco_529-Apr-15 5:01
MemberMarco_529-Apr-15 5:01 
AnswerRe: "HRESULT: 0x80210003" Pin
quarklaudiano30-Sep-15 23:59
Memberquarklaudiano30-Sep-15 23:59 
GeneralRe: "HRESULT: 0x80210003" Pin
tawfeek15-Mar-16 11:56
Membertawfeek15-Mar-16 11:56 
GeneralRe: "HRESULT: 0x80210003" Pin
Member 1259218619-Jun-16 6:49
MemberMember 1259218619-Jun-16 6:49 
QuestionIs this dll for all scanner or for specific scanner Pin
Sabyasachi Misra9-Apr-15 20:19
professionalSabyasachi Misra9-Apr-15 20:19 
AnswerRe: Is this dll for all scanner or for specific scanner Pin
Member 1295166521-Nov-17 0:37
MemberMember 1295166521-Nov-17 0:37 
Questionany body answer my Question ? Pin
Amir Mir Motahari7-Feb-15 9:05
MemberAmir Mir Motahari7-Feb-15 9:05 

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.