GetSelectedDevice Method

Summary

Gets a string that contains the ID for currently selected device.

Syntax

C++/CLI

Python

public string GetSelectedDevice()

public: 
String^ GetSelectedDevice();

def GetSelectedDevice(self):

Return Value

String that contains the ID for currently selected device. If an error occurs, an exception is thrown.

Remarks

Call this function to get a string that represents the ID for the currently selected device.

WIA does not have a default device selection. In order for this function to succeed be sure to call either SelectDeviceDlg or SelectDevice before calling this method.

Note:

If you are using the AcquireSimple method to automatically acquire from your device then it is not necessary to call either of the two mentioned functions above before calling the GetSelectedDevice since AcquireSimple method internally calls the SelectDeviceDlg method and this will assure you have a device currently selected.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
       
public void EnumDevicesExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version1)) 
   { 
      Console.WriteLine("WIA version 1.0 not installed."); 
      return; 
   } 
 
   WiaSession wiaSession = new WiaSession(); 
   wiaSession.Startup(WiaVersion.Version1); 
 
   DialogResult res = wiaSession.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault); 
   if (res != DialogResult.OK) 
   { 
      Console.WriteLine("Error selecting WIA device."); 
      wiaSession.Shutdown(); 
      return; 
   } 
 
   wiaSession.EnumDevicesEvent += new EventHandler<WiaEnumDevicesEventArgs>(wiaSession_EnumDevicesEvent); 
 
   Console.WriteLine("Available WIA Devices:\n"); 
   wiaSession.EnumDevices(); 
 
   wiaSession.EnumDevicesEvent -= new EventHandler<WiaEnumDevicesEventArgs>(wiaSession_EnumDevicesEvent); 
 
   wiaSession.Shutdown(); 
} 
 
void wiaSession_EnumDevicesEvent(object sender, WiaEnumDevicesEventArgs e) 
{ 
   string strMsg = string.Empty; 
 
   // print out some information about each device found into the console window. 
   strMsg = string.Format("\tDevice Name: {0}\n\tDevice Id: {1}\n\tDevice Description: {2}\n\n", e.DeviceName, e.DeviceID, e.DeviceDesc); 
   Console.WriteLine(strMsg); 
}