|
The DTWAIN_ArraySetAtFrame function gets all the coordinate values defined by a DTWAIN_FRAME within a DTWAIN_ARRAY.
DTWAIN_BOOL DTWAIN_ArraySetAtFrame (
|
DTWAIN_ARRAY
|
FraneArray
|
|
LONG
|
index,
|
|
DTWAIN_FLOAT
|
pLeft,
|
|
DTWAIN_FLOAT
|
pTop,
|
|
DTWAIN_FLOAT
|
pRight,
|
|
DTWAIN_FLOAT
|
pBottom );
|
Parameters
FrameArray
A DTWAIN_ARRAY of DTWAIN_ARRAYFRAME type.
index
0-based index of value to retrieve within the array
pLeft
DTWAIN_FLOAT that will be used to set the Left x value or NULL.
pTop
DTWAIN_FLOAT that will be used to set the Top y value or NULL.
pRight
DTWAIN_FLOAT that will be used to set the Right x value or NULL.
pBottom
DTWAIN_FLOAT that will be used to set the 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
DTWAIN_ArraySetAtFrame is a specialized version of DTWAIN_ArraySetAt.
The DTWAIN_ArraySetAtFrame copies the value Value to a position in the DTWAIN_ARRAY Array. The Index argument is the position to place the value, and must be in the range of 0 to n-1 where n is the number of elements in the array.
This function will only work for DTWAIN_ARRAY's that can store DTWAIN_FRAME values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYFRAME style. See DTWAIN_ArrayCreate for more information).
TWAIN State Transitions
None.
Prerequisite Function Call(s)
DTWAIN_SysInitialize
See Also
DTWAIN Frame Functions
|