DTWAIN_ArraySetAtFrameString

DTWAIN_ArraySetAtFrameStringA

DTWAIN_ArraySetAtFrameStringW

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

DTWAIN_BOOL DTWAIN_ArraySetAtFrameString (

DTWAIN_ARRAY	FrameArray
LONG	index,
LPCTSTR	pLeft,
LPCTSTR	pTop,
LPCTSTR	pRight,
LPCTSTR	pBottom );

Parameters

FrameArray

A DTWAIN_ARRAY of DTWAIN_ARRAYFRAME type.

index

0-based index of DTWAIN_FRAME value to set within the array

pLeft

String that will be used to set Left x value or NULL.

pTop

String that will be used to set Top y value or NULL.

pRight

String that will be used to set Right x value or NULL.

pBottom

String that will be used to set 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_ArraySetAtFrameStringA
Unicode version:	DTWAIN_ArraySetAtFrameStringW

Comments

The DTWAIN_ArraySetAtFrameString does the same thing as DTWAIN_ArraySetAtFrame, except that the values being set are strings in pLeft, pTop, pRight, and pBottom.

If the LPCTSTR 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