DTWAIN_EnableIndicator

Top  Previous  Next

The DTWAIN_EnableIndicator function turns on or off the progress indicator when acquiring images.

 

DTWAIN_BOOL DTWAIN_EnableIndicator (

DTWAIN_SOURCE

Source

DTWAIN_BOOL

bEnable );

         

Parameters

Source

An open TWAIN Source.

 

bEnable

Determines whether to turn on or off the progress indicator when acquiring images

 

Return Values

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

 

Comments

The DTWAIN_EnableIndicator function turns on or off the Source's progress indicator when acquiring images.  If bEnable is TRUE, the progress indicator is turned on, else it is turned off.  This function should be called before acquiring any images.

 

For acquisitions that do not require the Source's user interface, the progress indicator should also be disabled by the application.  If not, the progress indicator may still be visible, even though the Source's user interface has been hidden or disabled.

 

Note that the Source may not support a progress indicator or support an application from turning off the progress indicator.  To check if the Source supports turning off the progress indicator, call DTWAIN_IsIndicatorSupported.

 

TWAIN State Transitions

The Source must be in State 4 or higher

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function