DTWAIN_SetMaxAcquisitions

Top  Previous  Next

The DTWAIN_SetMaxAcquisitions function sets the maximum number of acquisitions allowed by a Source.

 

DTWAIN_BOOL DTWAIN_SetMaxAcquisitions (

DTWAIN_SOURCE

Source,

LONG

NumAcquisitions );

 

Parameters

Source

A DTWAIN_SOURCE denoting a TWAIN Source.

 

NumAcquisitions

The maximum number of acquisitions or DTWAIN_MAXACQUIRE.

 

Return Values

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

 

Comments

The DTWAIN_SetMaxAcquisitions function sets the maximum number of acquisitions that the Source Source will attempt before closing the Source's user interface (UI).  The NumAcquisitions must be >= 1 or the constant DTWAIN_MAXACQUIRE.  If the value is DTWAIN_MAXACQUIRE, the Source will allow an infinite number of acquisitions to be performed without closing.

 

If NumAcquisitions is set to 1, the Source UI will close when the first set of images have been acquired.  By default, the Source will allow an infinite amount of acquisitions to be performed when the Source is enabled.

 

The Source Source does not have to be enabled for DTWAIN_SetMaxAcquisitions to take effect.  If you are writing an application that will deal with multiple Sources, each Source's maximum acquisition count can be set safely.

 

TWAIN State Transitions

None

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function

 

See Also

Acquiring Images