DTWAIN_ArrayGetAtFrame

The DTWAIN_ArrayGetAtFrame function gets all the coordinate values defined by a DTWAIN_FRAME within a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayGetAtFrame (

Parameters

FrameArray

A DTWAIN_ARRAY of DTWAIN_ARRAYFRAME type.

index

0-based index of value to retrieve within the array

pLeft

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

pTop

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

pRight

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

pBottom

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

Return Values

TRUE if successful, FALSE otherwise. If the function returns FALSE, call DTWAIN_GetLastError() to get extended information.

Comments

The DTWAIN_ArrayGetAtFrame function retrieves the values that define the DTWAIN_FRAME at index index within the array FrameArray.

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)