DTWAIN_SetCompressionType

Top  Previous  Next

The DTWAIN_SetCompressionType function sets the compression method used when a buffered image transfer is done.

 

DTWAIN_BOOL DTWAIN_SetCompressionType (

DTWAIN_SOURCE

Source,

LONG

Compression,

DTWAIN_BOOL

bSetCurrent );

 

Parameters

Source

An open TWAIN Source.

 

Compression

Compression type to use when a buffered method transfer is performed.

 

bSetCurrent

Indicates whether to set the current or default compression type.

 

Return Values

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

 

Comments

The DTWAIN_SetCompressionType function sets the Source Source current or default compression setting.  The compression setting is used when a call to DTWAIN_AcquireBuffered is invoked.

 

If bSetCurrent is TRUE, the compression Compression is used as the current compression value.  If bSetCurrent is FALSE, the Compression argument is ignored and the default compression is used.  See DTWAIN Compression Constants for a list of the various compression modes.

 

TWAIN State Transitions

The Source must be in State 4. or higher

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

DTWAIN Source Selection Function

 

 

See Also

Setting Buffered Transfer Mode Parameters