DTWAIN_GetAcquireArea

Top Previous Next

The DTWAIN_GetAcquireArea function gets the current or default image acquisition area.

DTWAIN_BOOL DTWAIN_GetAcquireArea (

DTWAIN_SOURCE	Source,
LONG	GetType,
LPDTWAIN_ARRAY	Area );

Parameters

Source

An open TWAIN Source.

GetType

Indicates which type of retrieval to do

Area

A pointer to a DTWAIN_ARRAY (LPDTWAIN_ARRAY) containing the values retrieved.

Return Values

The return value is TRUE if successful. Otherwise FALSE is returned.

Comments

The DTWAIN_GetAcquireArea function gets the current or default image acquisition area of the Source Source. The dimensions are returned in the DTWAIN_ARRAY located at the address Area. The DTWAIN_ARRAY will be of type DTWAIN_ARRAYFLOAT

The GetType can be one of the following:

GetType	Definition
DTWAIN_AREACURRENT	Get the current area.
DTWAIN_AREADEFAULT	Get the default area.

The DTWAIN_GetAcquireArea creates and fills the DTWAIN_ARRAY located at the address Area on return with four values. The values for each element of the DTWAIN_ARRAY are defined as follows:

Position in Array	Definition
0, 1	Upper left (0), top (1) position of rectangle.
2, 3	Lower right (2), bottom (3) position of rectangle.

The following topic discusses getting the current unit of measure for the acquisition area:

Units of Measure and Image Acquisition.

TWAIN State Transitions

The Source must be in State 4.

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function