DTWAIN_RangeGetNearestValueFloat

The DTWAIN_RangeGetNearestValueFloat function gets the range value that is closest to a given value.

DTWAIN_BOOL DTWAIN_RangeGetNearestValueFloat (

DTWAIN_RANGE	Range,
DTWAIN_FLOAT	ValueIn,
LPDTWAIN_FLOAT	pValueOut,
LONG	RoundType );

Parameters

Range

A valid DTWAIN_RANGE type.

ValueIn

Value to search for.

pValueOut

Address where nearest value will be stored on return of DTWAIN_RangeGetNearestValueFloat.

RoundType

Determines whether to round to the nearest range value, round up to the next range value, or round down to the previous range value.

Return Values

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

Comments

DTWAIN_RangeGetNearestValueFloat is a specialized version of DTWAIN_RangeGetNearestValue that works with DTWAIN_RANGE that stores DTWAIN_FLOAT values. The only difference between DTWAIN_RangeGetNearestValueFloat and DTWAIN_RangeGetNearestValue is that the second parameter, ValueIn, is not an address, but the actual DTWAIN_FLOAT value to search for.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize