TwainAcquireToDibI Method (GdPictureImaging)

In This Topic

Acquires a single image, from the currently selected Data Source to a DIB handle.

Syntax

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

'Declaration
 
Public Function TwainAcquireToDibI( _
   ByVal HANDLE As Integer _
) As Integer

public int TwainAcquireToDibI( 
   int HANDLE
)

public function TwainAcquireToDibI( 
    HANDLE: Integer
): Integer;

public function TwainAcquireToDibI( 
   HANDLE : int
) : int;

public: int TwainAcquireToDibI( 
   int HANDLE
)

public:
int TwainAcquireToDibI( 
   int HANDLE
)

Parameters

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

0: The bitmap could not created. Use the GetStat(), TwainGetLastResultCode() and TwainGetLastConditionCode() methods for diagnosing the error. Non-zero: DIB handle. This handle must be subsequently released using the MemoryUtils.Free() method.

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.

This method requires the Document Capture (TWAIN / WIA) component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members
GetStat Method
TwainGetState Method
TwainLastXferFail Method
TwainUserClosedSource Method
TwainSetHideUI Method
TwainOpenDefaultSource(Int32) Method