TwainGetImageLayout Method (GdPictureImaging)

In This Topic

Returns the physical area (a rectangle) to be acquired during the next image transfer.

Syntax

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

'Declaration

 

Public Function TwainGetImageLayout( _

   ByRef Left As Double, _

   ByRef Top As Double, _

   ByRef Right As Double, _

   ByRef Bottom As Double _

) As Boolean

public bool TwainGetImageLayout( 

   ref double Left,

   ref double Top,

   ref double Right,

   ref double Bottom

)

public function TwainGetImageLayout( 

   var  Left: Double;

   var  Top: Double;

   var  Right: Double;

   var  Bottom: Double

): Boolean;

public function TwainGetImageLayout( 

   Left : double,

   Top : double,

   Right : double,

   Bottom : double

) : boolean;

public: bool TwainGetImageLayout( 

   ref double Left,

   ref double Top,

   ref double Right,

   ref double Bottom

)

public:

bool TwainGetImageLayout( 

   double% Left,

   double% Top,

   double% Right,

   double% Bottom

)

Parameters

Left: Value of the left-most edge of the area to scan measured in inches.
Top: Value of the top-most edge of the area to scan measured in inches.
Right: Value of the right-most edge of the area to scan measured in inches. Note: ImageWidth = Right - Left.
Bottom: Value of the bottom-most edge of the area to scan measured in inches. Note: ImageHeight = Bottom - Top.

Return Value

True if success, else False -> Use TwainGetLastResultCode() and TwainGetLastConditionCode() methods for diagnosing the error.

Remarks

Before using this method check that the TWAIN state is 4 (TWAIN_SOURCE_OPEN) To get the TWAIN state, use the TwainGetState() method.

Reference

GdPictureImaging Class
GdPictureImaging Members
TwainGetState Method
TwainResetImageLayout Method
TwainSetImageLayout Method