DTWAIN_ArrayAddFrame

The DTWAIN_ArrayAddFrame function adds a DTWAIN_FRAME value to the end of a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayAddFrame (

DTWAIN_ARRAY	Array,
DTWAIN_FRAME	Value );

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

Value

DTWAIN_FRAME value.

Return Values

If the function succeeds, TRUE is returned. If the function fails FALSE is returned.

Comments

The DTWAIN_ArrayAddFrame function appends the value Value to the end of the DTWAIN_ARRAY Array. The number of elements in the DTWAIN_ARRAY is increased by 1. DTWAIN_ArrayAddFrame is a specialized version of DTWAIN_ArrayAdd for DTWAIN_FRAME values.

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