←Select platform

AcquireFast2 Method


(Document/Medical only) Acquires one or more images from a TWAIN source and stores the images in the specified file(s).


Public Sub AcquireFast2( _ 
   ByVal baseFileName As String, _ 
   ByVal startupPageNumber As Integer, _ 
   ByVal flags As Leadtools.Twain.TwainFastUserInterfaceFlags, _ 
   ByVal transferMode As Leadtools.Twain.TwainTransferMode, _ 
   ByVal format As Leadtools.RasterImageFormat, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal multiPage As Boolean, _ 
   ByVal bufferSize As Integer, _ 
   ByVal usePreferredBufferSize As Boolean _ 


The base name of the image file(s) to which to save the acquired data.

The starting page number where the numbering of the newly scanned files names starts. For example, if this parameter has the value 3, then the scanned files will have the name "BaseFileName_0003.bmp".

Pass -1 for this parameter to start numbering files from page 1, in this case the first scanned file will have the format "BaseFileName_0001.bmp".

Flag that indicates whether to display the manufacturer's user interface.

The transfer mode used to acquire.

The image format used to acquire.

Represents the BitsPerPixel used to acquire.

True for multi-page acquire, or false for single page.

Specifies the buffer size (in bytes) used to acquire images.

Specifies whether to use the preferred buffer size specified by the TWAIN driver. true to use the preferred buffer size, false to use the user-defined buffer size (bufferSize parameter).


Use the Acquire method to acquire one or more images. Use the AcquireFast2 method to acquire one or more images and save them to one or more files. This function was added in order to allow users to prevent already scanned files from being overwritten by a subsequent scan batch. To prevent such over-writing, specify the page number where the new files creation should start numbering files. For example, three pages have been scanned while the specified baseFileName parameter was "BaseFileName.bmp", the output files will have the names "BaseFileName_0001.bmp", "BaseFileName_0002.bmp" and "BaseFileName_0003.bmp". Then if a new scan starts while the startPageNumber is -1 then these saved files will be overwritten. But in order to avoid that, pass a 4 for the startPageNumber parameter so the new scanned files will start from 4 as "BaseFileName_0004.bmp", then "BaseFileName_0005.bmp", ...etc. Based on the scanner type, this method will determine the best/fastest scanning method to use. This scanning method will be used when actually scanning the images. Before calling this method, call the FindFastConfiguration method to determine the best scan configuration. Note:If the FindFastConfiguration method is not called before the AcquireFast method, then the AcquireFast method will determine the best scanning method. If the file format set in the format parameter does not support multi-page files, this method will ignore the multiPage parameter and automatically save the scanned images to separate files. The files are named by appending numbers to the string used for the baseFileName. For example, if the string in baseFileName is "Temp.jpg", and the startPageNumber is -1, the method will append the number of the image, 0001, 0002, etc., to the name of the file. Therefore, the output file names will be "Temp0001.jpg", "Temp0002.jpg", etc. But if startPageNumber is not -1 (which should be any value bigger than zero), then the numbering will start from that value. If for example the startPageNumber contains the value 4 then the output file names will be "Temp0004.jpg", "Temp0005.jpg", etc. If the file format specified in the format parameter supports multi-page files, this method will use the multiPage parameter to determine how to save multiple images. If multi is set to false, each scanned page will be saved to a separate file, named in the same manner described in the paragraph above. If multiPage is set to true, the name of the output file will be the exact string in baseFileName (Temp.jpg) and it will be saved as a multi-page file. To use the AcquireMultiPage event, set the EnableAcquireMultiPageEvent property value to true before calling the AcquireFast method. The AcquireMultiPage event will be fired twice for each scanned page. The event is fired the first time when the TWAIN source begins scanning the page. The event is fired the second time when the TWAIN source has finished scanning the page. For more information, refer to How to Acquire from the Twain Source. For more information, refer to Fast TWAIN (Scan Configurations).


using Leadtools; 
using Leadtools.Twain; 
public void twain_AcquireMulti2(object sender, TwainAcquireMultiPageEventArgs e) 
   string msg; 
   if (e.FinishScan) 
      msg = String.Format("The page # {0} is scanned and saved to file name {1}", e.PageNumber, e.FileName); 
   e.Cancel = false; 
public void AcquireFast2Example(IntPtr parent) 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
   session.EnableAcquireMultiPageEvent = true; 
   session.AcquireMultiPage += new EventHandler<TwainAcquireMultiPageEventArgs>(twain_AcquireMulti2); 
   session.AcquireFast2(Path.Combine(LEAD_VARS.ImagesDir, "Out_test.tif"), 
                       3, // start page number to use when numbering output file names, output files should be test_0003.tif, test_0004.tif, ...etc 
                       RasterImageFormat.Tif, 1, true, 0, true); 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
Imports Leadtools 
Imports Leadtools.Twain 
Public Sub twain_AcquireMulti2(ByVal sender As Object, ByVal e As TwainAcquireMultiPageEventArgs) 
   Dim msg As String 
   If e.FinishScan Then 
      msg = String.Format("The page # {0} is scanned and saved to file name {1}", e.PageNumber, e.FileName) 
   End If 
   e.Cancel = False 
End Sub 
Public Sub AcquireFast2Example(ByVal parent As IntPtr) 
   Dim session As TwainSession = New TwainSession() 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None) 
   session.EnableAcquireMultiPageEvent = True 
   AddHandler session.AcquireMultiPage, AddressOf twain_AcquireMulti2 
   ' 3, start page number to use when numbering output file names, output files should be test_0003.tif, test_0004.tif, ...etc 
   session.AcquireFast2(Path.Combine(LEAD_VARS.ImagesDir, "test.tif"), 
                        TwainFastUserInterfaceFlags.Show, TwainTransferMode.Buffer, RasterImageFormat.Tif, 1, True, 0, True) 
End Sub 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 


Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Twain Assembly