DTWAIN_GetCompressionType

The DTWAIN_GetCompressionType function gets the compression method used when a buffered image transfer is done.

DTWAIN_BOOL DTWAIN_GetCompressionType (

DTWAIN_SOURCE	Source,
LPLONG	lpCompression,
DTWAIN_BOOL	bGetCurrent );

Parameters

Source

An open TWAIN Source.

lpCompression

Address of a LONG variable that will receive the compression type.

bGetCurrent

Indicates whether to get the current or default compression type.

Return Values

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

Comments

The DTWAIN_GetCompressionType function gets the Source Source current or default compression setting. The compression setting is used when a call to DTWAIN_AcquireBuffered is invoked. The address lpCompression is used to store the compression value.

If bGetCurrent is TRUE, the current value used by the Source will be stored at the address lpCompression, otherwise the default value is stored at lpCompression. See DTWAIN Compression Constants for a list of the various compression modes. To get a list of all of the supported compression type, call DTWAIN_EnumCompressionTypes function,

TWAIN State Transitions

The Source must be in State 4 or higher

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function