Leadtools.Twain Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.8.31
AcquireToImage Method
See Also  Example
Leadtools.Twain Namespace > TwainSession Class : AcquireToImage Method




flags
Indicates whether to display the manufacturer's user interface.
Acquires one or more images from a TWAIN source.

Syntax

Visual Basic (Declaration) 
Public Function AcquireToImage( _
   ByVal flags As TwainUserInterfaceFlags _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim flags As TwainUserInterfaceFlags
Dim value As RasterImage
 
value = instance.AcquireToImage(flags)
C# 
public RasterImage AcquireToImage( 
   TwainUserInterfaceFlags flags
)
Managed Extensions for C++ 
public: RasterImage AcquireToImage( 
   TwainUserInterfaceFlags flags
)
C++/CLI 
public:
RasterImage AcquireToImage( 
   TwainUserInterfaceFlags flags
)

Parameters

flags
Indicates whether to display the manufacturer's user interface.

Return Value

One of the DialogResult values. If an error occurs, an exception is thrown.

Example

Visual BasicCopy Code
Public Sub AcquireToImageExample(ByVal parent As IWin32Window)
   Dim session As TwainSession = New TwainSession()
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)

   Dim twCap As TwainCapability = New TwainCapability()

   twCap.Information.Type = TwainCapabilityType.ImageTransferMechanism
   twCap.Information.ContainerType = TwainContainerType.OneValue
   twCap.OneValueCapability.ItemType = TwainItemType.Uint16
   twCap.OneValueCapability.Value = TwainCapabilityValue.TransferMechanismNative

   session.SetCapability(twCap, TwainSetCapabilityMode.Set)
   Dim img As RasterImage = session.AcquireToImage(TwainUserInterfaceFlags.Show)

   '
   ' save the acquired image here...
   '

   session.Shutdown()
End Sub
C#Copy Code
public void AcquireToImageExample(IWin32Window parent) 
{ 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
 
   TwainCapability twCap = new TwainCapability(); 
 
   twCap.Information.Type = TwainCapabilityType.ImageTransferMechanism; 
   twCap.Information.ContainerType = TwainContainerType.OneValue; 
   twCap.OneValueCapability.ItemType = TwainItemType.Uint16; 
   twCap.OneValueCapability.Value = TwainCapabilityValue.TransferMechanismNative; 
 
   session.SetCapability(twCap, TwainSetCapabilityMode.Set); 
   RasterImage img = session.AcquireToImage(TwainUserInterfaceFlags.Show); 
 
   // 
   // save the acquired image here... 
   // 
 
   session.Shutdown(); 
}

Remarks

Use the Acquire method to acquire one or more images. Use the AcquireFast method to acquire one or more images and save them to one or more files.
The number of pages to acquire can be determined by getting the TWAIN source's capabilities. To change the number of pages to acquire, set the appropriate capability to the desired number.
This method will get images from the selected TWAIN source and pass them into an RasterImage object to the AcquirePage event through the TwainAcquirePageEventArgs class.
For each image acquired by the currently selected TWAIN source, an AcquirePage event is generated.
The Acquire method acquires pages in the following transfer modes:
  • Native - gets the images being scanned into the memory as a whole.
  • Memory Buffered - gets images from the source as strips of data. These strips can be merged to get the whole image.
To set the transfer mode, call SetCapability with the appropriate capability constant.
For more information, refer to How to Acquire from the Twain Source.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also