DTWAIN_ArrayInsertAtString

Top Previous Next

The DTWAIN_ArrayInsertAtString inserts a string into a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayInsertAtString (

DTWAIN_ARRAY	Array
LONG	Index
LPCTSTR	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.

Character specific version

ANSI version:	DTWAIN_ArrayInsertAtStringA
Unicode version:	DTWAIN_ArrayInsertAtStringW

Comments

DTWAIN_ArrayInsertAtString is a specialized 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.

Since this function requires an LPCTSTR, the type of string that can be stored will depend on whether the ANSI or Unicode version of the DTWAIN DLL is being used. If the ANSI version of the DLL is used

(DTWAIN32.DLL, DTWAIN64.DLL), then the type of string stored will be ANSI, If the Unicode version of DTWAIN is used (DTWAIN32U.DLL, DTWAIN64U.DLL), the type of string will be a wide or Unicode string.

For storing specifically ANSI or Wide strings, use DTWAIN_ArrayInsertAtANSIString or DTWAIN_ArrayInsertAtWideString, respectively.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize