Public Function Acquire( _
   ByVal owner As IWin32Window, _
   ByVal item As Object, _
   ByVal flags As WiaAcquireFlags _
) As DialogResult

Visual Basic (Usage)	Copy Code
Dim instance As WiaSession Dim owner As IWin32Window Dim item As Object Dim flags As WiaAcquireFlags Dim value As DialogResult   value = instance.Acquire(owner, item, flags)

public DialogResult Acquire( 
   IWin32Window owner,
   object item,
   WiaAcquireFlags flags
)

public:
DialogResult Acquire( 
   IWin32Window^ owner,
   Object^ item,
   WiaAcquireFlags flags
) 

Parameters

owner

Window handle of your application window.

item

This parameter is only used when acquiring from scanner device and the ShowUserInterface flag is NOT set. Use this parameter to specify the scanner’s paper source (Feeder or Flatbed).

This flag is optional. If you are using WIA 1.0 you can change the paper source by changing the WiaPropertyId.ScannerDeviceDocumentHandlingSelect property value for the root item or by enumerating the available scanner items and passing the item to be used for scanning.

If you are using WIA 2.0 either enumerate the available scanner items and pass the item to be used for scanning, or pass null (Nothing in Visual Basic), in which case the enumeration will be performed internally and the first enumerated item will be used as the source item.

flags

Flag that determines certain actions of the WIA image acquisition selection dialog box. Possible values are:

Value	Meaning
WiaAcquireFlags.None	Default behavior for the device image acquisition dialog box.
WiaAcquireFlags.SingleImage	Restrict image selection to a single image in the device image acquisition dialog box. This flag is not available if you are using WIA version 2.0.
WiaAcquireFlags.ShowUserInterface	Show the manufacturer’s image acquisition dialog box.
WiaAcquireFlags.UseCommonUI	Use the system user interface (UI), if available, rather than the vendor-supplied UI. If the system UI is not available, the vendor UI is used.

Return Value

This function will acquire single or multiple images from the selected WIA device.

Make sure to call WiaSession.Startup and then call any of the WiaSession.SelectDeviceDlg or WiaSession.SelectDevice functions before calling this function.

You can change the Leadtools.Wia.WiaSession.AcquireOptions property members before calling this method to control some options while acquiring from the WIA source.

Set this method for memory transfer or file transfer by performing one of the following:

• Set the transfer mode you wish to use through the WiaSession.SetProperties method.
• Set the transfer mode by setting the value parameter to any of the transfer modes available through the WiaTransferMode and then call the WiaSession.SetPropertyLong method passing WiaPropertyId.ItemTymed for the propertyId parameter of this method.

When performing memory transfer you need to add the WiaSession.AcquireEvent event to receive the acquired page(s). The event will also provide you with the percent completion of the page transfer progress.

When performing file transfer it is optional to add the WiaSession.AcquireEvent event since the event will only provide you with the saved file path and the percent completion of the file saving process.

When performing file transfer two properties within the WiaSession class will become available:

• FilesCount - contains the count of the saved files.
• FilesPaths - a collection that contains the saved file paths and filenames.

To cancel the acquire operation you need to add the WiaSession.AcquireEvent event and set the Cancel member of the WiaAcquireEventArgs to true.

For more information, refer to How to Acquire from the WIA Source.

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

Reference