DTWAIN_ArrayRemoveAt

The DTWAIN_ArrayRemoveAt removes an element from a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayRemoveAt (

DTWAIN_ARRAY	Array
LONG	Index );

Parameters

Array

DTWAIN_ARRAY where the element will be removed.

Index

Position to remove the inserted value

Return Values

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

Comments

The DTWAIN_ArrayRemoveAt function removes the element located at position Index. All values in the DTWAIN_ARRAY that were placed after the removed value are moved 'up' by one position. For example, if the element in position 3 is removed, the values that were placed after position 3 are moved up by one position.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize