DTWAIN_ArrayAdd

The DTWAIN_ArrayAdd function adds a value to the end of a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayAdd (

DTWAIN_ARRAY	Array,
LPVOID	pValue );

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

pValue

Address of the value to add.

Return Values

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

Comments

The DTWAIN_ArrayAdd function adds the value located at address pValue to the end of the DTWAIN_ARRAY Array. The number of elements in the DTWAIN_ARRAY is increased by 1.

The data type of the value located at the address pValue must match the data type that is stored in Array. DTWAIN cannot determine the data type located at address pValue, therefore it is the responsibility of the programmer to provide the correct type.

An alternative to DTWAIN_ArrayAdd are the following specialized versions of DTWAIN_ArrayAdd that work for specific types of DTWAIN_ARRAY's:

DTWAIN_ArrayAddFloat

DTWAIN_ArrayAddLong

DTWAIN_ArrayAddLong64

DTWAIN_ArrayAddANSIString

DTWAIN_ArrayAddWideString

DTWAIN_ArrayAddString

Note: For ease of use, when adding strings to a DTWAIN_ARRAY, it is recommended to use the DTWAIN_ArrayAddANSIString(), DTWAIN_ArrayAddWideString(), and DTWAIN_ArrayAddString() functions.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize