DTWAIN_GetAcquireArea2String

Top Previous Next

The DTWAIN_GetAcquireArea2String function gets the current image acquisition area.

DTWAIN_BOOL DTWAIN_GetAcquireArea2String (

DTWAIN_SOURCE	Source,
LPTSTR	lpLeft,
LPTSTR	lpTop,
LPTSTR	lpRight,
LPTSTR	lpBottom,
LPLONG	lpUnit );

Parameters

Source

An open TWAIN Source.

lpLeft

Indicates upper left of rectangle to acquire.

lpTop

Indicates top of rectangle to acquire.

lpRight

Indicates right of rectangle to acquire.

lpBottom

Indicates bottom of rectangle to acquire.

lpUnit

Unit of measure used to describe left, top, right, and bottom of rectangle

Return Values

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

Comments

The DTWAIN_GetAcquireArea2String function works exactly the same way as DTWAIN_GetAcquireArea2, with the exception of the lpLeft, lpTop, lpRight, and lpBottom parameters are string buffers that will be filled on return with the rectangle's values instead of DTWAIN_FLOAT parameters. See DTWAIN_GetAcquireArea2 for more details.

The LPTSTR arguments must point to a buffer large enough to hold the necessary string information. The string information will not exceed 255 characters.

TWAIN State Transitions

The Source must be in State 4. or higher (depending on the capability).

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function