DTWAIN_ArrayAddANSIStringN

The DTWAIN_ArrayAddANSIStringN function adds N copies of a string value to the end of a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayAddANSIStringN (

DTWAIN_ARRAY	Array,
LPCSTR	Value,
LONG	NumCopies);

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

Value

Pointer to character buffer.

NumCopies

Number of copies of Value to add to the array.

Return Values

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

Comments

The DTWAIN_ArrayAddANSIStringN function appends NumCopies of the contents of the buffer located at Value to the end of the DTWAIN_ARRAY Array. The number of elements in the DTWAIN_ARRAY is increased by NumCopies.

For example, if Array currently has two values: "Name1", and "Name2",

DTWAIN_ArrayAddANSIStringN(Array, "abc123", 4);

will result in Array containing the following values:

Name1

Name2

abc123

This function will only work for DTWAIN_ARRAY's that can store 8-bit ANSI character strings values. The DTWAIN_ARRAY must be created with

1) The DTWAIN_ARRAYANSISTRING style

2) with the DTWAIN_ARRAYSTRING style if using the ANSI version of the DTWAIN library (DTWAIN32.DLL, DTWAIN64.DLL).

To insert 16-bit (Unicode) character strings, use DTWAIN_ArrayAddWideString.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize