DTWAIN_SetBufferedTileMode

Top  Previous  Next

The DTWAIN_SetBufferedTileMode function sets whether the TWAIN Source will use tiles instead of strips when acquring buffered images.

 

DTWAIN_BOOL DTWAIN_SetBufferedTileMode (

DTWAIN_SOURCE

Source,

DTWAIN_BOOL

SetMode );

 

Parameters

Source

A DTWAIN_SOURCE denoting a TWAIN Source.

 

SetMode

If TRUE, the TWAIN device will acquire buffered images using tiles.  If FALSE, the device will use strips when acquiring buffered images.

 

Return Values

The return value is TRUE if successful.  Otherwise FALSE is returned.  If FALSE is returned, call DTWAIN_GetLastError() to obtain the reason for the failure.

 

Comments

The DTWAIN_SetBufferedTileMode function is used to set the Source's transfer of tiled data instead of strips when DTWAIN_AcquireBuffered or DTWAIN_AcquireBufferedEx() is used to acquire images.  Only TWAIN devices that support tiling are able to transfer data as tiles instead of strips.  


If SetMode is TRUE, DTWAIN_SetBufferedTileMode() will set the device to transfer buffered data as tiles instead of strips.  If SetMode is FALSE, strips will be used when transferring image data,  By default, all devices transfer buffered data as strips.  


If SetMode is TRUE, and the return value of DTWAIN_SetBufferedTileMode() is FALSE, call DTWAIN_GetLastError() to determine the reason for the failure to set the tile mode.  One reason would be that the device does not support tiled data.  You can determine if the device will support tiled data by issuing a call to DTWAIN_IsCapSupported, using DTWAIN_CV_ICAPTILES as the capability to query.

 

TWAIN State Transitions

None

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function

 

See Also

Buffered Transfer