DTWAIN_ArrayAddFrameN

The DTWAIN_ArrayAddFrameN function adds N DTWAIN_FRAME values to the end of a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayAddFrameN (

DTWAIN_ARRAY	Array,
DTWAIN_FRAME	Value,
LONG	NumCopies);

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

Value

DTWAIN_FRAME value.

NumCopies

Number of copies of Value to add to the array.

Return Values

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

Comments

The DTWAIN_ArrayAddFrameN function appends NumCopies of the value Value to the end of the DTWAIN_ARRAY Array. The number of elements in the DTWAIN_ARRAY is increased by NumCopies.

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