ICAP_AUTOMATICCROPUSESFRAME

Description

Set TRUE if DAT_IMAGELAYOUT, ICAP_SUPPORTEDSIZES or ICAP_FRAMES reduces the amount of data captured from the device, potentially improving the performance of the driver, even if any automatic detection capability like ICAP_AUTOMATICBORDERDECTION is set TRUE.

This is a read only capability.

Application

If this capability reports TRUE then the Application may assume a performance benefit from specifying a cropping frame using DAT_IMAGELAYOUT, ICAP_SUPPORTEDSIZES or ICAP_FRAMES.

The Application sets the frame after turning on any automated capabilities. For instance, if the Application wants automatic border detection, but knows that the largest paper size it will receive is US Letter, then it sets ICAP_AUTOMATICBORDERDETECTION to TRUE and then sets ICAP_SUPPORTEDSIZES to TWSS_USLETTER.

Source

Values

The Source reports TRUE if it uses the cropping frame specified by DAT_IMAGELAYOUT, ICAP_SUPPORTEDSIZES or ICAP_FRAMES to reduce the amount of data physically transferred from the device to the Source.

The Source is not obligated to exactly match the frame requested by the Application, but it should use it as a hint to improve the performance of the capture.

Type: TW_BOOL

Allowed Values: TRUE or FALSE

Containers

MSG_GET TW_ONEVALUE TW_ENUMERATION

MSG_GETCURRENT TW_ONEVALUE

MSG_GETDEFAULT TW_ONEVALUE

MSG_SET Not Allowed MSG_SETCONSTRAINT Not Allowed MSG_RESET Not Allowed MSG_QUERYSUPPORT TW_ONEVALUE

Required By

None

TWAIN Version Introduced

Version 2.1

Related

ICAP_AUTOMATICBORDERDETECTION ICAP_FRAMES ICAP_SUPPORTEDSIZES