DTWAIN_FrameGetAll

Top Previous Next

The DTWAIN_FrameGetAll function gets all the coordinate values defined by the DTWAIN_FRAME

DTWAIN_BOOL DTWAIN_FrameGetAll (

DTWAIN_FRAME	Frame,
LPDTWAIN_FLOAT	pLeft,
LPDTWAIN_FLOAT	pTop,
LPDTWAIN_FLOAT	pRight,
LPDTWAIN_FLOAT	pBottom );

Parameters

Frame

A valid DTWAIN_FRAME type.

pLeft

Address of DTWAIN_FLOAT that will be used to store Left x value

pTop

Address of DTWAIN_FLOAT that will be used to store Top y value

pRight

Address of DTWAIN_FLOAT that will be used to store Right x value

pBottom

Address of DTWAIN_FLOAT that will be used to store Bottom y value

Return Values

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

Comments

The DTWAIN_FrameGetAll function retrieves the values that define the DTWAIN_FRAME. The addresses of the values that will be retrieved by DTWAIN_FrameGetAll must be passed.

A DTWAIN_FRAME describes a rectangular region defined by the following (x, y) coordinates:

(Left, Top) as the upper left corner of the rectangle, and (Right, Bottom) as the lower right corner of the rectangle.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize