DTWAIN_ArrayGetAtFrameString

DTWAIN_ArrayGetAtFrameStringA

DTWAIN_ArrayGetAtFrameStringW

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

DTWAIN_BOOL DTWAIN_ArrayGetAtFrame (

DTWAIN_ARRAY	FraneArray
LONG	index,
LPTSTR	pLeft,
LPTSTR	pTop,
LPTSTR	pRight,
LPTSTR	pBottom );

Parameters

FrameArray

A DTWAIN_ARRAY of DTWAIN_ARRAYFRAME type.

index

0-based index of value to retrieve within the array

pLeft

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

pTop

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

pRight

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

pBottom

Address of character buffer 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.

Character specific version

ANSI version:	DTWAIN_ArrayGetAtFrameStringA
Unicode version:	DTWAIN_ArrayGetAtFrameStringW

Comments

The DTWAIN_ArrayGetAtFrameString does the same thing as DTWAIN_ArrayGetAtFrame, except that the values are returned as strings in pLeft, pTop, pRight, and pBottom.

If the LPTSTR parameter is NULL,, the parameter is skipped.

This function is useful if the computer language used to write your application doesn't use or handle DTWAIN_FLOAT variable types correctly, and you want to call DTWAIN functions that use DTWAIN_FLOAT values.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize