DTWAIN_ArrayInsertAt

The DTWAIN_ArrayInsertAt inserts a value into a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayInsertAt (

DTWAIN_ARRAY	Array
LONG	Index
LPVOID	pValue );

Parameters

Array

DTWAIN_ARRAY that the value will be inserted into.

Index

Position to place the inserted value

pValue

32-bit pointer to the address of the inserted value.

Return Values

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

Comments

The DTWAIN_ArrayInsertAt function inserts the value located at the address pValue in the DTWAIN_ARRAY Array. The Index argument is the position to insert the value. The value is inserted before the value located at position Index. The Index argument is numbered from 0 (the first position) to any positive number.

The data type of the value located at the address pValue must match the data type that is stored in Array (see DTWAIN_ARRAY Data Types and DTWAIN Array Data Type Constants). DTWAIN cannot determine the data type located at address pValue, therefore it is the responsibility of the programmer to provide the correct type.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize