TwainAcquireToFile(String,Int32) Method

In This Topic

Acquires a single image, from the currently selected Data Source to a file. This method uses the file transfer mode. The disk file mode is ideal when transferring large images that might encounter memory limitations with Native or memory mode. However, Disk File mode is a bit slower than other transfer mode. -> The output image format should be negotiated with the TwainSetImageFileFormat() method. -> The output image compression should be negotiated with the TwainSetCompression() method.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function TwainAcquireToFile( _
   ByVal FilePath As String, _
   ByVal HANDLE As Integer _
) As GdPictureStatus

public GdPictureStatus TwainAcquireToFile( 
   string FilePath,
   int HANDLE
)

public function TwainAcquireToFile( 
    FilePath: String;
    HANDLE: Integer
): GdPictureStatus;

public function TwainAcquireToFile( 
   FilePath : String,
   HANDLE : int
) : GdPictureStatus;

public: GdPictureStatus TwainAcquireToFile( 
   string* FilePath,
   int HANDLE
)

public:
GdPictureStatus TwainAcquireToFile( 
   String^ FilePath,
   int HANDLE
)

Parameters

FilePath: The path of the image file to create.
HANDLE: A Window Handle IE: Me.Handle. In most applications you can use nothing but on Citrix and WTS, this must be a top-level window or a child of a top level window.

Return Value

A member of the GdPictureStatus enumeration.

Remarks

By default, the default data source (DS) is opened, displays its dialog, and determines all the parameters of the acquisition and transfer. If you want to (try to) hide the DS dialog, see TwainSetHideUI. Before using this method check that the TWAIN state is >= 4 (TWAIN_SOURCE_OPEN) To get the TWAIN state, use the TwainGetState() method. To set the TWAIN state to 4, use the TwainOpenDefaultSource() or TwainOpenSource() method. Warning: To works, this method requires that the current Data source allows file transfer mode. Use the TwainIsFileTransferModeAvailable() to check if the source support this mode of transfer.

Reference

GdPictureImaging Class
GdPictureImaging Members
Overload List
TwainGetState Method
TwainLastXferFail Method
TwainUserClosedSource Method
TwainSetHideUI Method
TwainOpenDefaultSource(Int32) Method
TwainSetImageFileFormat Method
TwainSetCompression Method
TwainIsFileTransferModeAvailable Method