DTWAIN_ArrayInsertAtN

Top  Previous  Next

The DTWAIN_ArrayInsertAtN inserts N copies of a value into a DTWAIN_ARRAY.

 

DTWAIN_BOOL DTWAIN_ArrayInsertAtN (

DTWAIN_ARRAY

Array

LONG

Index

LPVOID

pValue 

LONG

NumCopies );

         

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.


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_ArrayInsertAtN function inserts NumCopies of the value located at the address pValue in the DTWAIN_ARRAY Array.  The Index argument is the position to insert the values.  The values are 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

 

See Also

Adding, Setting, and Inserting elements in a DTWAIN_ARRAY