DTWAIN_RewindPage

Top  Previous  Next

The DTWAIN_RewindPage function allows an application to "rewind" a page back to the input of a document feeder

 

DTWAIN_BOOL DTWAIN_RewindPage ( DTWAIN_SOURCE Source );

 

 

Parameters

Source

Specifies an open TWAIN Source.

 

Return Values

If the function succeeds, TRUE is returned.  If the function fails FALSE is returned.

 

Comments

The DTWAIN_RewindPage function returns the current page to the input side of the document feeder and

feeds the last page from the output side of the feeder back into the acquisition area.

 

If an application decides to control the document feeding process, DTWAIN_RewindPage allows the application to return a document back to the feeder input area.

 

For DTWAIN_RewindPage to be successful, all of the following items must be true:

 

The Source supports a document feeder (call DTWAIN_IsFeederSupported)

The application has enabled the feeder (call DTWAIN_EnableFeeder)

The Source supports the DTWAIN_CV_CAPREWINDPAGE capability (call DTWAIN_IsCapSupported)

The application has turned off the auto feed (call DTWAIN_EnableAutoFeed with a FALSE argument) before the acquisition process has started.

The application calls DTWAIN_RewindPage during the process of acquiring.

 

For the last item listed above, calling DTWAIN_RewindPage can only be invoked if the application is using DTWAIN Notifications, and has intercepted the DTWAIN_TN_TRANSFERSTRIPREADY, DTWAIN_TN_TRANSFERSTRIPDONE, or DTWAIN_TN_TRANSFERDONE notifications.  Only at these designated times should DTWAIN_RewindPage be called by the application.

 

Application control of the document feeder is best done using buffered memory transfers (DTWAIN_AcquireBuffered).

 

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

DTWAIN Source Selection Function

 

DTWAIN_EnableFeeder

DTWAIN_EnableAutoFeed (with bEnable = FALSE)

A DTWAIN Acquisition Function (preferrably DTWAIN_AcquireBuffered).

 

See Also

Automatic Document Feeder Support