DTWAIN_ArrayInsertAtWideString

The DTWAIN_ArrayInsertAtWideString inserts a wide (Unicode) string into a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayInsertAtWideString (

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 wide string to insert.

Return Values

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

Comments

DTWAIN_ArrayInsertAtWideString is a speicalized version of the DTWAIN_ArrayInsertAt function.

The DTWAIN_ArrayInsertAtWideString function inserts the wide 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 wide (Unicde) or 16-bit character strings values.  The DTWAIN_ARRAY must be created  with

1) The DTWAIN_ARRAYWIDESTRING style

or

2) with the DTWAIN_ARRAYSTRING style if using the Unicode version of the DTWAIN library (DTWAIN32U.DLL, DTWAIN64U.DLL).

To insert 8-bit or ANSI character strings, use DTWAIN_ArrayInsertAtANSIString.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize

See Also

Adding, Setting, and Inserting elements in a DTWAIN_ARRAY