DTWAIN_GetSourceUnit

Top Previous Next

The DTWAIN_GetSourceUnit gets the current unit of measure used by a Source.

DTWAIN_BOOL DTWAIN_GetSourceUnit (

DTWAIN_SOURCE	Source,
LPLONG	lpUnit );

Parameters

Source

Specifies a TWAIN Source.

lpUnit

Address of LONG that receives the current device unit of measure.

Return Values

If the function succeeds, TRUE is returned. If unsuccessful, FALSE is returned.

Comments

The DTWAIN_GetSourceUnit function gets the current unit of measure used by the Source. The unit of measure is stored in the address of the LONG pointed to by lpUnit.

The unit of measure determines which unit the Source is using when describing certain quantities such as image size. For more information on units of measure used by the Source, see Units of Measure and Image Acquisition.

TWAIN State Transitions

The Source must be in State 4 or higher.

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function