DTWAIN_FrameGetValue

Top Previous Next

The DTWAIN_FrameGetValue function gets either the low, high, step, default, or current values in the DTWAIN_FRAME.

DTWAIN_BOOL DTWAIN_FrameGetValue (

DTWAIN_FRAME	Frame,
LONG	WhichValue,
LPDTWAIN_FLOAT	lpValue );

Parameters

Frame

A valid DTWAIN_FRAME type.

WhichValue

Value to retrieve.

lpValue

Address of where retrieved value will be copied.

Return Values

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

Comments

The DTWAIN_FrameGetValue function retrieves a value from the DTWAIN_FRAME Frame. The WhichValue denotes the value from the DTWAIN_FRAME that is to be retrieved. The WhichValue can be one of the following:

Constant	Value	Defintion
DTWAIN_FRAMELEFT	1	Left value
DTWAIN_FRAMETOP	2	Top value
DTWAIN_FRAMERIGHT	3	Right value
DTWAIN_FRAMEBOTTOM	4	Bottom

The lpValue is the address of where the retrieved data will be copied. To get all the values that define the DTWAIN_FRAME with a single function call, use the DTWAIN_FrameGetAll function.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize