DTWAIN_ArrayInsertAtString

Top Previous Next

The DTWAIN_ArrayInsertAtString inserts a DTWAIN_FLOAT value into a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayInsertAtString (

DTWAIN_ARRAY	Array
LONG	Index
LPCSTR	Value );

Parameters

Array

DTWAIN_ARRAY that the value will be inserted into.

Index

Position to place the inserted value

Value

A pointer to a null-terminated string to insert.

Return Values

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

Comments

DTWAIN_ArrayInsertAtString is a speicalized version of the DTWAIN_ArrayInsertAt function.

The DTWAIN_ArrayInsertAtString function inserts the string pointed to by Value 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.

This function will only work for DTWAIN_ARRAY's that can store string values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYSTRING style. See DTWAIN_ArrayCreate for more information).

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize