DTWAIN_RangeSetValue

Top  Previous  Next

The DTWAIN_RangeSetValue function sets either the low, high, step, default, or current values in the DTWAIN_RANGE.

 

DTWAIN_BOOL DTWAIN_RangeSetValue (

DTWAIN_RANGE

Range,

LONG

WhichValue,

LPVOID

lpValue );

 

Parameters

Range

A valid DTWAIN_RANGE type.

 

WhichValue

Range value to set

 

lpValue

Address of the new value to set in the DTWAIN_RANGE

 

 

Return Values

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

 

Comments

The DTWAIN_RangeSetValue function sets a value in the DTWAIN_RANGE Range.  The WhichValue denotes the value in the DTWAIN_RANGE that is to be set.  The WhichValue can be one of the following:

 

Constant

Value        

Defintion

DTWAIN_RANGEMIN

1

Minimum value

DTWAIN_RANGEMAX

2

Maximum value

DTWAIN_RANGESTEP

3

Step size

DTWAIN_RANGEDEFAULT

4

Default value

DTWAIN_RANGECURRENT

5

Current value

 

The lpValue is the address of the value that is to be used to set in the DTWAIN_RANGE.  Since DTWAIN_RANGEs can differ in data types, the caller to this function is responsible in seeing that the data type residing at lpValue matches the data type stored in Range.

 

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

DTWAIN Range Functions