DTWAIN_RangeGetAll

Top Previous Next

The DTWAIN_RangeGetAll function gets the low, high, step, default, and current values in the DTWAIN_RANGE.

DTWAIN_BOOL DTWAIN_RangeGetAll (

DTWAIN_RANGE	Range,
LPVOID	llpMin
LPVOID	lpMax
LPVOID	lpStep
LPVOID	lpDef
LPVOID	lpCur );

Parameters

Range

A valid DTWAIN_RANGE type.

lpMin

Address of Minimum value.

lpMax

Address of Maximum value

lpStep

Address of Step value

lpDef

Address of default value or NULL

lpCur

Address of current value or NULL

Return Values

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

Comments

The DTWAIN_RangeGetAll function retrieves the values that define the DTWAIN_RANGE. The addresses of the values that will be retrieved by DTWAIN_RangeGetAll must be passed, not the actual values. Since DTWAIN_RANGEs can differ in data types, the caller to this function is responsible in seeing that the data residing in the DTWAIN_RANGE matches the data type sent to DTWAIN_RangeGetAll (either DTWAIN_RANGELONG or DTWAIN_RANGEFLOAT).

If the lpDef or lpCur values are NULL, the default value or the current value is ignored.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize