CAP_CLEARPAGE

Description

If TRUE, the Source will eject the current page being acquired from and will leave the feeder acquire area empty.

If CAP_AUTOFEED is TRUE, a fresh page will be advanced.

CAP_FEEDERENABLED must equal TRUE to use this capability.

This capability must have been negotiated as an extended capability to be used in States 5 and 6.

Application

Do a MSG_SET on this capability to advance the document in the feeder acquire area to the output area and abort all transfers pending on this page.

This capability is used in States 5 and 6 by applications controlling the Source’s feeder (usually without the Source user interface).

This capability can also be used while CAP_AUTOFEED equals TRUE to abort all remaining transfers on this page and continue with the next page.

Source

Values

If CAP_FEEDERENABLED equals FALSE, return TWRC_FAILURE / TWCC_CAPSEQERROR (capability is not supported in current settings).

If supported, advance the document in the feeder-acquire area to the output area and abort all pending transfers from this page.

The Source will perform this action once whenever the capability is MSG_SET to TRUE. The Source should then revert the Current value to FALSE.

Type: TW_BOOL

Value after MSG_OPENDS: FALSE

After MSG_RESET/MSG_RESETALL: FALSE

Allowed Values: TRUE or FALSE

Containers

MSG_GET TW_ONEVALUE TW_ENUMERATION // 2.0 and higher

MSG_GETCURRENT TW_ONEVALUE

MSG_GETDEFAULT TW_ONEVALUE

MSG_SET TW_ONEVALUE

MSG_SETCONSTRAINT TW_ONEVALUE TW_ENUMERATION // 2.0 and higher

MSG_RESET TW_ONEVALUE

MSG_QUERYSUPPORT TW_ONEVALUE

Required By

None

TWAIN Version Introduced

Version 1.0

Related

CAP_AUTOFEED CAP_EXTENDEDCAPS CAP_FEEDERENABLED CAP_FEEDERLOADED CAP_FEEDPAGE CAP_REWINDPAGE